consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
e666c28c5c83d27762baa5c49f1bdd94086ad0d1
nairobi/docs/en/installation/local_installation.md
Javi Martín e666c28c5c Update instructions for the bin/setup command 
This command simplifies some of the steps. However, there's a gotcha: it
might fail if the database requires username and password and they
haven't been configured before executing it.
2024-08-07 15:48:21 +02:00

2.0 KiB
Raw Blame History

Local installation

Before installing Consul Democracy and having it up and running make sure you all prerequisites installed.

  1. First, clone the Consul Democracy Github repository and enter the project folder:
git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy
  1. Install the Ruby version we need with your Ruby version manager. Here are some examples:
rvm install `cat .ruby-version` # If you're using RVM
rbenv install `cat .ruby-version` # If you're using rbenv
asdf install ruby `cat .ruby-version` # If you're using asdf
  1. Check we're using the Ruby version we've just installed:
ruby -v
=> # (it should be the same as the version in the .ruby-version file)
  1. Copy the example database configuration file:
cp config/database.yml.example config/database.yml
  1. Setup database credentials with your consul user in your new database.yml file
nano config/database.yml

And edit the lines containing username: and password:, adding your credentials.

  1. Install the project dependencies and create the database:
bin/setup
  1. Run the following Rake task to fill your local database with development data:
bin/rake db:dev_seed
  1. Check everything is fine by running the test suite (beware it might take more than an hour):
bin/rspec
  1. Now you have all set, run the application:
bin/rails s

Congratulations! Your local Consul Democracy application will be running now at http://localhost:3000.

In case you want to access the local application as admin, a default user verified and with admin permissions was created by the seed files with username admin@consul.dev and password 12345678.

If you need an specific user to perform actions such as voting without admin permissions, a default verified user is also available with username verified@consul.dev and password 12345678.