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.

Configuration for development and test environments

NOTE: For more detailed instructions check the docs

a. using docker-compose (recommended)

git clone https://github.com/consul/consul.git
cd consul
# add the composer-specific database config
cp config/database-docker.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
cp .env.example .env
# build the required images
docker-compose build
# choose a database password and spawn the containers
docker-compose up
# connect to the app container and prepare the database
docker exec -it consul_app_1 bash -li
bin/rake db:create
bin/rake db:migrate
bin/rake db:dev_seed
RAILS_ENV=test rake db:setup
# ready to use -- by default, port 3000 is exposed on host

Troubleshooting

# Sometimes a lockfile prevents the containers to be restarted
# in this case, it is safe to just remove it
host$ rm tmp/pids/server.pid
# If the cache gets corrupted simply clean it
host$ rm -rf tmp/cache/*

b. on host

Prerequisites: install git, Ruby 2.6.7, CMake, pkg-config, shared-mime-info, Node.js and PostgreSQL (>=9.5).

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

Run the tests with:

# Optionally; it takes a long time to complete
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

Debugging

The DelayedJobs process log can be found at /home/deploy/consul/current/log/delayed_job.log.

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