This is the source code for the server-side application (the "API") of IMPACT OSS.
It is a Rails 5.0.1 application and is a thin server that is responsible for:
- database management and access via an API (Application Programming Interface)
- user authentication
- automated email reminders
It complements the IMPACT OSS client-side application (the "UI") that you can find here: https://github.com/impactoss/impactoss-client
- public User Interface (UI)
- admin UI
IMPACT OSS is an Open Source Software (OSS) for Integrated Management and Planning of Actions (IMPACT), created to assist States with coordinating and monitoring implementation of human rights and the Sustainable Development Goals (SDGs).
The IMPACT OSS project is maintained by the Impact Open Source Software Trust. To learn more about the project and the Trust see https://impactoss.org
The IMPACT OSS installation guide provides detailed instructions on how to configure and install both server and client applications: https://install-guide.impactoss.org/
This project requires:
- Ruby 2.3.3, preferably managed using rbenv
- PhantomJS (in order to use the poltergeist gem)
- PostgreSQL must be installed and accepting connections
On a Mac, you can obtain all of the above packages using Homebrew. If you wish to use Docker, the above dependencies will be provided by the Dockerfile and docker-compose file included in this repository.
If you need help setting up a Ruby development environment, check out this Rails OS X Setup Guide.
cp config/secrets-sample.yml config/secrets.yml
and edit. You can generate a new secret to use, like this:
cp config/initializers/devise-sample.rb config/initializers/devise.rb
Then edit to include a secret_key, example:
# rubocop:disable Metrics/LineLength
config.secret_key = 'your-secret-goes-here'
# rubocop:enable Metrics/LineLength
This project uses overcommit to enforce code style. To enable overcommit locally
gem install overcommit
You'll need to sign the overcommit (verify you're happy with it executing). Do this after installing, and again every time the overcommit config changes.
To install the extra linters, run
[sudo] pip install yamllint
npm install -g jshint
docker-compose up to create and start a DB and app image, with the app listening on port 3000. You will also need to run
docker-compose run app rake db:setup to create and seed a development database. The app has several configuration value that can be set that are listed in the
example.env file. You can either copy this file to
.env and provide your own configuration, or explicitly pass in your configuration to the
docker run command.
If you already have a database instance and just wish to run the app you will need to build the image:
docker build . -t "undp-human-rights-national-reporting"
And then run the resulting image:
docker run undp-human-rights-national-reporting -P -e PGHOST=YOUR_DB_HOST -e PGUSER=YOUR_PG_USER
bin/setup script. This script will:
- Check you have the required Ruby version
- Install gems using Bundler
- Create local copies of
- Create, migrate, and seed the database
rake specto make sure everything works.
rails sto start the Rails app.
This project is licensed under the MIT license, see LICENSE.md.