Technical Documentation
Return to Main Documentation
ENGLISH - version 2.3
ENGLISH - version 2.3
  • Introduction
  • Getting started
    • Create your fork
    • Configure your fork
    • Keep your fork updated
    • Communication
  • Installation
    • Local installation
      • Prerequisites
      • Ubuntu Linux
      • Debian Linux
      • macOS
      • Windows
      • Vagrant
      • Docker
    • Production and staging servers
      • Installer
      • Create a deploy user
      • Generating SSH Key
      • Manual installation (not recommended)
      • Digital Ocean
      • Heroku
      • Mail server configuration
    • Basic configuration
    • User documentation and guides
  • Customization
    • Introduction
    • Translations and texts
    • Images
    • Styles with CSS
    • JavaScript
    • Models
    • Controllers
    • Views and HTML
    • Components
    • Other Ruby classes (GraphQL, lib, mailers, builders)
    • Gems
    • Application configuration
    • Routes
    • Tests
  • Technical Features
    • OAuth
    • GraphQL
    • Debates and proposals recommendations
    • Configure Census Connection
    • Local Census
    • Multitenancy
    • User content translations
  • Open Source project
    • Code of conduct
    • Contributing
    • Coding conventions
    • Open source forks and modifications
    • License
Powered by GitBook
On this page
  • CONSUL DEMOCRACY
  • CONSUL DEMOCRACY Project main website
  • Configuration for development and test environments
  • Configuration for production environments
  • License
  • Contributions

Introduction

NextGetting started

Last updated 1 month ago

CONSUL DEMOCRACY

Citizen Participation and Open Government Application

CONSUL DEMOCRACY Project main website

Configuration for development and test environments

Prerequisites: install git, Ruby 3.2.8, CMake, pkg-config, Node.js 18.20.3, ImageMagick and PostgreSQL (>=9.5).

Note: The bin/setup command below might fail if you've configured a username and password for PostgreSQL. If that's the case, edit the lines containing username: and password: (adding your credentials) in the config/database.yml file and run bin/setup again.

git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy
bin/setup
bin/rake db:dev_seed

Run the app locally:

bin/rails s

You can run the tests with:

bin/rspec

Note: running the whole test suite on your machine might take more than an hour, so it's strongly recommended that you setup a Continuous Integration system in order to run them using parallel jobs every time you open or modify a pull request (if you use GitHub Actions or GitLab CI, this is already configured in .github/workflows/tests.yml and .gitlab-ci.yml) and only run tests related to your current task while developing on your machine. When you configure the application for the first time, it's recommended that you run at least one test in spec/models/ and one test in spec/system/ to check your machine is properly configured to run the tests.

You can use the default admin user from the seeds file:

user: admin@consul.devpass: 12345678

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

user: verified@consul.devpass: 12345678

Configuration for production environments

License

Contributions

You can access the main website of the project at where you can find documentation about the use of the platform, videos, and links to the community space.

NOTE: For more detailed instructions, check the .

See

Code published under AFFERO GPL v3 (see )

See

http://consuldemocracy.org
local installation docs
installer
LICENSE-AGPLv3.txt
CONTRIBUTING.md
CONSUL DEMOCRACY logo