Skip to content

OpenSourcePolitics/decidim-cea

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

Deploy

  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)

Machine translation configuration

Machine translation is configured through the provider DeepL by using the gem https://github.com/wikiti/deepl-rb.

In order to make it work these ENV variables need to be configured:

TRANSLATOR_API_KEY=*******
TRANSLATOR_HOST=https://api-free.deepl.com
  • Obtain the TRANSLATOR_API_KEY by creating an account at https://www.deepl.com/pro#developer
  • For TRANSLATOR_HOST, set it to https://api-free.deepl.com if using the "DeeL API Free" plan. If using the "DeepL API Pro", then set it to https://api.deepl.com

Note: you still need to enable machine translation at the organization settings.