79 lines
3.5 KiB
Markdown
79 lines
3.5 KiB
Markdown
|
|
|
|
# CONSUL
|
|
|
|
Citizen Participation and Open Government Application
|
|
|
|
[](https://travis-ci.org/consul/consul)
|
|
[](https://codeclimate.com/github/consul/consul)
|
|
[](https://gemnasium.com/consul/consul)
|
|
[](https://coveralls.io/github/consul/consul?branch=master)
|
|
[](https://crowdin.com/project/consul)
|
|
[](http://www.gnu.org/licenses/agpl-3.0)
|
|
|
|
[](https://www.w3.org/WAI/eval/Overview)
|
|
[](https://rocketvalidator.com/opensource)
|
|
|
|
[](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3APRs-welcome)
|
|
|
|
This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website.
|
|
|
|
## Current state
|
|
|
|
Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 September 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6).
|
|
|
|
## Configuration for development and test environments
|
|
|
|
**NOTE**: For more detailed instructions check the [docs](https://consul_docs.gitbooks.io/docs/content/en/getting_started/prerequisites/)
|
|
|
|
Prerequisites: install git, Ruby (the version defined in the `.ruby-version` file in the CONSUL repository), the bundler gem, Node.js and PostgreSQL (>=9.4).
|
|
|
|
```bash
|
|
git clone https://github.com/consul/consul.git
|
|
cd consul
|
|
bundle install
|
|
cp config/database.yml.example config/database.yml
|
|
cp config/secrets.yml.example config/secrets.yml
|
|
bin/rake db:create
|
|
bin/rake db:migrate
|
|
bin/rake db:dev_seed
|
|
RAILS_ENV=test rake db:setup
|
|
```
|
|
|
|
Run the app locally:
|
|
|
|
```
|
|
bin/rails s
|
|
```
|
|
|
|
Prerequisites for testing: install ChromeDriver >= 2.33
|
|
|
|
Run the tests with:
|
|
|
|
```
|
|
bin/rspec
|
|
```
|
|
|
|
You can use the default admin user from the seeds file:
|
|
|
|
**user:** admin@consul.dev
|
|
**pass:** 12345678
|
|
|
|
But for some actions like voting, you will need a verified user, the seeds file also includes one:
|
|
|
|
**user:** verified@consul.dev
|
|
**pass:** 12345678
|
|
|
|
## Documentation
|
|
|
|
You can find this project documentation at <https://github.com/consul/docs>.
|
|
|
|
## License
|
|
|
|
Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt)).
|
|
|
|
## Contributions
|
|
|
|
See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md).
|