/decidim-cunit-app

Decidim APP for Cunit

Primary LanguageHTMLGNU Affero General Public License v3.0AGPL-3.0

decidim_cunit

Free Open-Source participatory democracy, citizen participation and open government for cities and organizations

This is the open-source repository for decidim_cunit, based on Decidim.

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.

By the moment, there's no Here Maps configured yet.

You're good to go!

Keep your fork synced

To keep your fork up-to-date with the upstream repository, i.e., to upgrade decidim, you must configure a remote that points to the upstream repository in Git.

# List the current configured remote repository for your fork.
$ git remote -v
# Specify the new remote upstream repository that will be synced with the fork.
$ git remote add decidim-clean git@gitlab.coditdev.net:decidim/decidim-clean-app.git
# Verify the new decidim-clean repository you've specified for your fork.
$ git remote -v

Syncing a fork

# Check out your fork's local master branch.
$ git checkout master
# Incorporate changes from the decidim-clean repository into the current branch.
$ git pull decidim-clean

Customize your fork

The following files should be modified:

  • package.json
  • config/application.rb
  • config/initializers/decidim.rb

Decorators and overrides

Decorators and overrides must be checked in Decidim upgrades.

Add personal data fields (name, surname and phone) in Proposals.

  • app/decorators/commands/proposals/

  • app/decorators/forms/proposals/

  • app/decorators/lib/proposals/

  • app/overrides/proposals/

Testing

Configure the name of the test DB in you config/application.yml file and run:

RAILS_ENV=test bundle exec rails db:create
RAILS_ENV=test bundle exec rails db:migrate
RAILS_ENV=test bundle exec rails db:schema:load

Require missing factories in spec/factories.rb

Add require "rails_helper" to your specs and execute them from the root directory, i.e.:

bundle exec rspec spec

Upgrades with clean-app

Documentation in docs/upgrade_apps.md.