As usual, we're updating the bundler version in our Gemfile.lock so it uses the one included in Ruby 3.2.3, and we're also updating the `parser` gem so it supports this version.
84 lines
4.1 KiB
Markdown
84 lines
4.1 KiB
Markdown
<!--
|
|
Title: CONSUL DEMOCRACY
|
|
Description: Citizen Participation and Open Government Application
|
|
Keywords: democracy, citizen participation, eparticipation, debates, proposals, voting, consultations, crowdlaw, participatory budgeting.
|
|
-->
|
|
|
|

|
|
|
|
# CONSUL DEMOCRACY
|
|
|
|
Citizen Participation and Open Government Application
|
|
|
|
[](http://www.gnu.org/licenses/agpl-3.0)
|
|
[](https://www.w3.org/WAI/eval/Overview)
|
|
|
|

|
|
[](https://codeclimate.com/github/consuldemocracy/consuldemocracy)
|
|
[](https://coveralls.io/github/consuldemocracy/consuldemocracy?branch=master)
|
|
[](https://translate.consuldemocracy.org/)
|
|
[](https://knapsackpro.com/dashboard/organizations/176/projects/202/test_suites/318/builds?utm_campaign=organization-id-176&utm_content=test-suite-id-318&utm_medium=readme&utm_source=knapsack-pro-badge&utm_term=project-id-202)
|
|
|
|
[](https://github.com/consuldemocracy/consuldemocracy/issues?q=is%3Aopen+label%3A"help+wanted")
|
|
|
|
This is the opensource code repository of the eParticipation website CONSUL DEMOCRACY, originally developed for the Madrid City government eParticipation website, and currently maintained by the open source software community in collaboration with the CONSUL DEMOCRACY Foundation.
|
|
|
|
## Documentation
|
|
|
|
Check the [ongoing documentation](https://docs.consuldemocracy.org/index) to learn more about how to start your own CONSUL DEMOCRACY fork, install it, customize it and learn to use it as an administrator/maintainer.
|
|
|
|
## CONSUL DEMOCRACY Foundation and project website
|
|
|
|
You can access the main website of the project at [http://consuldemocracy.org](http://consuldemocracy.org) where you can find information about the use of the platform, the CONSUL DEMOCRACY Foundation, the global community of users and local partners, news, and ways to get more support or get in touch.
|
|
|
|
## Configuration for development and test environments
|
|
|
|
**NOTE**: For more detailed instructions check the [docs](https://docs.consuldemocracy.org)
|
|
|
|
Prerequisites: install git, Ruby 3.2.3, CMake, pkg-config, shared-mime-info, Node.js 18.18.2 and PostgreSQL (>=9.5).
|
|
|
|
```bash
|
|
git clone https://github.com/consuldemocracy/consuldemocracy.git
|
|
cd consuldemocracy
|
|
bin/setup
|
|
bin/rake db:dev_seed
|
|
```
|
|
|
|
Run the app locally:
|
|
|
|
```bash
|
|
bin/rails s
|
|
```
|
|
|
|
Run the tests with:
|
|
|
|
```bash
|
|
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
|
|
|
|
## Configuration for production environments
|
|
|
|
See [installer](https://github.com/consuldemocracy/installer)
|
|
|
|
## Current state
|
|
|
|
Development started on [2015 July 15th](https://github.com/consuldemocracy/consuldemocracy/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 september 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features at the [project's website](http://consuldemocracy.org/) and future features at the [Roadmap](https://github.com/orgs/consuldemocracy/projects/1) and [open issues list](https://github.com/consuldemocracy/consuldemocracy/issues).
|
|
|
|
## License
|
|
|
|
Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt))
|
|
|
|
## Contributions
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|