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
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 in features or docs and future features in the open issues list. For current status on upcoming features go to Roadmap
Configuration for development and test environments
NOTE: For more detailed instructions check the docs
Prerequisites: install git, Ruby 2.3.2, bundler gem, 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 PhantomJS >= 2.1.1
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
Please check the ongoing documentation at https://consul_docs.gitbooks.io/docs/content/ 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. You can contribute to it at https://github.com/consul/docs
License
Code published under AFFERO GPL v3 (see LICENSE-AGPLv3.txt)
Contributions
See CONTRIBUTING.md
Working with Docker
Prerequisites
You should have installed Docker and Docker Compose in your machine.
Macos
brew install docker
brew install docker-compose
brew cask install docker
open -a docker
You'll be asked to give Docker app permissions and type your password, then you're set.
Linux
- Install Docker:
sudo apt-get update
sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main'
sudo apt-get update
apt-cache policy docker-engine
sudo apt-get install -y docker-engine
- Install Docker Compose
sudo curl -o /usr/local/bin/docker-compose -L "https://github.com/docker/compose/releases/download/1.15.0/docker-compose-$(uname -s)-$(uname -m)"
sudo chmod +x /usr/local/bin/docker-compose
Installation
Then lets create our secrets and database config files based on examples:
cp config/secrets.yml.example config/secrets.yml
cp config/database-docker.yml.example config/database.yml
Then you'll have to build the container with:
sudo docker build -t consul .
Create your app database images:
sudo docker-compose up -d database
Once built you can initialize your development DB and populate it with:
sudo docker-compose run app rake db:create
sudo docker-compose run app rake db:migrate
sudo docker-compose run app rake db:seed
sudo docker-compose run app rake db:dev_seed
Running local CONSUL with Docker
Now we can finally run the application with:
sudo docker-compose up
And you'll be able to acces it at your browser visiting http://localhost:3000
Additionally, if you want to run the rails console just run in another terminal:
sudo docker-compose run app rails console
To verify the containers are up execute sudo docker ps . You should see output similar to this:
