7e3eb28ce1
GitHub treats help-wanted as a special label, so we're using it instead of PRs welcome. I'm still keeping the "PRs welcome" text and icon because it sound less aggressive than "help wanted".
93 lines
4.1 KiB
Markdown
93 lines
4.1 KiB
Markdown
<!--
|
|
Title: CONSUL
|
|
Description: Citizen Participation and Open Government Application
|
|
Keywords: democracy, citizen participation, eparticipation, debates, proposals, voting, consultations, crowdlaw, participatory budgeting
|
|
-->
|
|
|
|
|
|
|
|
# CONSUL
|
|
|
|
Citizen Participation and Open Government Application
|
|
|
|
[](https://travis-ci.org/consul/consul)
|
|
[](https://codeclimate.com/github/consul/consul)
|
|
[](https://coveralls.io/github/consul/consul?branch=master)
|
|
[](https://crowdin.com/project/consul)
|
|
[](http://www.gnu.org/licenses/agpl-3.0)
|
|
[](https://houndci.com)
|
|
|
|
[](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%3A"help+wanted")
|
|
|
|
This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website
|
|
|
|
## Documentation
|
|
|
|
Check the ongoing documentation at [https://docs.consulproject.org](https://docs.consulproject.org) to learn more about how to start your own CONSUL fork, install it, customize it and learn to use it from an administrator/maintainer perspective.
|
|
|
|
## CONSUL Project main website
|
|
|
|
You can access the main website of the project at [http://consulproject.org](http://consulproject.org) where you can find documentation about the use of the platform, videos, and links to the community space.
|
|
|
|
## Configuration for development and test environments
|
|
|
|
**NOTE**: For more detailed instructions check the [docs](https://docs.consulproject.org)
|
|
|
|
Prerequisites: install git, Ruby 2.3.2, `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:
|
|
|
|
```bash
|
|
bin/rails s
|
|
```
|
|
|
|
Prerequisites for testing: install ChromeDriver >= 2.33
|
|
|
|
Run the tests with:
|
|
|
|
```bash
|
|
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
|
|
|
|
## Configuration for production environments
|
|
|
|
See [installer](https://github.com/consul/installer)
|
|
|
|
## 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 at the [project's website](http://consulproject.org/) and future features at the [Roadmap](https://github.com/consul/consul/projects/6) and [open issues list](https://github.com/consul/consul/issues).
|
|
|
|
## License
|
|
|
|
Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt))
|
|
|
|
## Contributions
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|