-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b49adfc
commit 15d12a9
Showing
2 changed files
with
39 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,137 +1,43 @@ | ||
| # Decidim app by OSP | ||
| # Decidim Lyon by OSP | ||
| [](https://codecov.io/gh/OpenSourcePolitics/decidim-app) | ||
| [](https://codeclimate.com/github/OpenSourcePolitics/decidim-app/maintainability) | ||
|  | ||
|  | ||
|
|
||
| Citizen Participation and Open Government application. | ||
| ## Decidim | ||
|  | ||
|
|
||
| ## Deploy with Terraform | ||
| [Decidim](https://github.com/decidim/decidim) is a digital platform for citizen participation. Related documentation can be found [here](https://docs.decidim.org) | ||
|
|
||
| Terraform is an open-source infrastructure as code software tool that provides an easy deployment of your infrastructure for installing Decidim. | ||
| ## [Open Source Politics](https://opensourcepolitics.eu/) | ||
|  | ||
|
|
||
| Many providers are available (**AWS**, **Heroku**, **DigitalOcean**...). Check the [Terraform registry to see how to use Terraform with your provider](https://registry.terraform.io/browse/providers) | ||
| This repository contains the code of the **decidim-app** implemented for our customers. | ||
|
|
||
| Each Terraform deployment are stored in the **deploy** folder and sorted by providers | ||
| It consists of the main application with modules developed by the community that we often use. | ||
|
|
||
| Feel free to add new deployments! | ||
| It includes **official modules** supported by the community and **community-based modules** developed by us our [our partners](https://github.com/decidim-ice) | ||
|
|
||
| ## Availables deployments | ||
| ## 🚀 Getting started | ||
| - See our [installation guide](./docs/GETTING_STARTED.md) to run a decidim-lyon by OSP locally | ||
| - See our [Docker installation guide](./docs/GETTING_STARTED_DOCKER.md) to run a decidim-lyon by OSP locally with Docker | ||
| - See our [homepage interactive map module](./docs/HOMEPAGE_INTERACTIVE_MAP.md) to configure module (OSX/Ubuntu) | ||
|
|
||
| - [Scaleway](https://github.com/OpenSourcePolitics/decidim-app/tree/develop/deploy/providers/scaleway) | ||
| - [DigitalOcean](https://github.com/OpenSourcePolitics/decidim-app/tree/develop/deploy/providers/digitalocean/) | ||
| ## Modules | ||
|
|
||
| ## Environment variables | ||
|
|
||
| Each provider will need a way to authenticate at their API. Make sure to set environment variables asked in the provider's documentation before using deployments. | ||
|
|
||
| - To use Scaleway's provider | ||
|
|
||
| ```bash | ||
| export SCW_ACCESS_KEY=<your_access_key> | ||
| export SCW_TOKEN=<your_scw_token> | ||
| export SCW_DEFAULT_PROJECT_ID=<id_of_your_project/organization> | ||
| ``` | ||
|
|
||
| - To use DigitalOcean's provider | ||
| ```bash | ||
| export DIGITALOCEAN_TOKEN=<your_do_token> | ||
| export SPACES_ACCESS_KEY_ID=<your_do_space_access_key> | ||
| export SPACES_SECRET_ACCESS_KEY=<your_do_space_secret_key> | ||
| ``` | ||
|
|
||
| ## How to deploy with Terraform? | ||
|
|
||
| Check the list of make commands in the Makefile. Each command corresponds to a provider and a specific need. | ||
|
|
||
| - To deploy a new infrastructure with Scaleway | ||
|
|
||
| ```make | ||
| make deploy-scw | ||
| ``` | ||
|
|
||
| ## Setting up the application | ||
|
|
||
| You will need to do some steps before having the app working properly once you've deployed it: | ||
|
|
||
| 1. Open a Rails console in the server: `bundle exec rails console` | ||
| 2. Create a System Admin user: | ||
| ```ruby | ||
| email = <your email> | ||
| password = <a secure password> | ||
| user = Decidim::System::Admin.new(email: email, password: password, password_confirmation: password) | ||
| user.save! | ||
| ``` | ||
| 3. Visit `<your app url>/system` and login with your system admin credentials | ||
| 4. Create a new organization. Check the locales you want to use for that organization, and select a default locale. | ||
| 5. Set the correct default host for the organization, otherwise the app will not work properly. Note that you need to include any subdomain you might be using. | ||
| 6. Fill the rest of the form and submit it. | ||
|
|
||
| You're good to go! | ||
|
|
||
| ## Running tests | ||
|
|
||
| This application has a functional testing suite. You can easily run locally the tests as following : | ||
|
|
||
| Create test environment database | ||
|
|
||
| `bundle exec rake test:setup` | ||
|
|
||
| And then run tests using `rspec` | ||
|
|
||
| `bundle exec rspec spec/` | ||
|
|
||
| ## Docker | ||
| ### How to use it? | ||
| You can boot a Decidim environment in Docker using the Makefile taht will run docker-compose commands and the last built image from the Dockerfile. | ||
| Three context are available : | ||
|
|
||
| - **Clean Decidim** | ||
|
|
||
| An environment running the current Decidim version (from Gemfile) without any data. | ||
| ```make | ||
| make start-clean-decidim | ||
| ``` | ||
|
|
||
| - **Seeded Decidim** | ||
|
|
||
| An environment running the current Decidim version (from Gemfile) with generated seeds | ||
| ```make | ||
| make start-seeded-decidim | ||
| ``` | ||
|
|
||
| - **Dumped Decidim** | ||
|
|
||
| An environment running the current Decidim version (from Gemfile) with real data dumped from an existing platform to simulate a Decidim bump version before doing in the real production environment. | ||
| ```make | ||
| make start-dumped-decidim | ||
| ``` | ||
| ***Warning : you need to get a psql dump on your local machine to restore it in your containerized database*** | ||
| ***Warning2 : you need to set organization host to 0.0.0.0 with the rails console*** | ||
|
|
||
|
|
||
| ### How to stop and remove it? | ||
|
|
||
| To get rid off your Docker environmnent : | ||
|
|
||
| - Shut down Docker environmnent | ||
| ```make | ||
| make stop | ||
| ``` | ||
|
|
||
| - Delete resources | ||
| ```make | ||
| make delete | ||
| * Paper ballots | ||
| You can test it by creating a CSV file like : | ||
| ```csv | ||
| id;paper_ballots_to_import | ||
| 6;550 | ||
| ``` | ||
| ### Troubleshooting | ||
|
|
||
| Make commands are available to help you troubleshoot your Docker environment | ||
|
|
||
| - Start Rails console | ||
| ```make | ||
| make rails-console | ||
| ``` | ||
| - Start bash session to app container | ||
| ```make | ||
| make connect-app | ||
| ``` | ||
| ## 👋 Contributing | ||
| - See our [contributing guide](./docs/CONTRIBUTING.md) | ||
|
|
||
| ## Database architecture (ERD) | ||
| ## 🔒 Security | ||
| Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by sending an email to **security[at]opensourcepolitics[dot]eu** and not by creating a Github issue. | ||
|
|
||
|  | ||
| ## License | ||
| The decidim-app is licensed under the [AGPLv3](./LICENSE-AGPLV3.txt), same license as Decidim. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters