Skip to content
This repository has been archived by the owner on Jun 1, 2022. It is now read-only.

OpenSourcePolitics/decidim-binic

Repository files navigation

OSP App

Citizen Participation and Open Government application.

This is a base app for all OSP projects. It uses OSP's decidim version.

Deploying the app

  • heroku run rake db:migrate
  • Set SEED=1 as ENV variable
  • heroku run rake db:seed --app osp-decidim
  • See (Setting up the application .3)

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:
user = Decidim::System::Admin.new(email: <email>, password: <password>, password_confirmation: <password>)
user.save!
  1. Visit <your app url>/system and login with your system admin credentials
  2. Create a new organization. Check the locales you want to use for that organization, and select a default locale.
  3. 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.
  4. Fill the rest of the form and submit it.

You're good to go!

How to deploy

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 start-clean-decidim
  • Seeded Decidim

An environment running the current Decidim version (from Gemfile) with generated seeds

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 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 stop
  • Delete resources
make delete

Troubleshooting

Make commands are available to help you troubleshoot your Docker environment

  • Start Rails console
make rails-console
  • Start bash session to app container
make connect-app

Database architecture (ERD)

  1. Use the "Deploy to Heroku" button
  2. Choose a name for the app, and organization and a tier
  3. Fill in the required env vars.
  4. Create the app
  5. Enable Review Apps for this app (you'll need to create a Pipeline)