FreeFrom is a nonprofit dedicated to helping survivors of domestic violence achieve financial stability. On their website they have a compensation tool where users can answer a series of questions in order to get information about financial resources that are available to them depending on their state.
This repository contains the new Rails backend for the compensation tool and the CMS that allows FreeFrom administrators to change the content in the tool.
Make sure you have ruby version 2.6.3 installed on your local machine, or install it using this guide: https://www.ruby-lang.org/en/documentation/installation/
Install and run a PostgreSQL version 11.4.
- Start a Postgres client session:
psql
- Create a new user:
create user "freefrom-compensation-api-user";
- Give that user special permissions:
alter user "freefrom-compensation-api-user" with superuser;
- Exit out of the client session:
exit
Run the command gem install rails
(make sure rails --version
returns 5.2.3)
- Clone this repository onto your local machine
cd
into thefreefrom-compensation-api
folder- Run
bundle install
to install the app's dependencies (rungem install bundler
if that doesn't work) - Run
rake db:setup
to create the test and development databases - Run
rake db:migrate
to set up the necessary database tables - Run
bundle exec rails s
to start the server
To contribute, see CONTRIBUTING.md