codefornl/consul repository overview

⁠CONSUL

Citizen Participation and Open Government Application

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⁠ 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⁠ where you can find documentation about the use of the platform, videos, and links to the community space.

⁠Development environment using Docker

git clone https://github.com/consul/consul.git
cd consul
docker-compose up -d app
docker-compose run migration #bring the database in the correct state

# Optional steps
docker-compose run prepare #install sample data

⁠Configuration for development and test environments

NOTE: For more detailed instructions check the docs⁠

Prerequisites: install git, Ruby 2.3.8, bundler gem, Node.js and PostgreSQL (>=9.4).

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: [email protected]⁠ pass: 12345678

But for some actions like voting, you will need a verified user, the seeds file also includes one:

user: [email protected]⁠ pass: 12345678

⁠Configuration for production environments

See installer⁠

⁠Current state

Development started on 2015 July 15th⁠. Code was deployed to production on 2015 september 7th to decide.madrid.es⁠. Since then new features are added often. You can take a look at the current features at the project's website⁠ and future features at the Roadmap⁠ and open issues list⁠.

⁠License

Code published under AFFERO GPL v3 (see LICENSE-AGPLv3.txt⁠)

⁠Contributions

See CONTRIBUTING.md⁠