README

The official repository for the Help Lesotho forums

Setup

NodeJS

This ain't no javascript app though!

Version 6.x

Yarn

See the docs;

Ruby

Only the latest and greatest 2.4.1

Recommended: use rbenv to manage ruby installations)

Postgresql

Version 9.5.7

Ensure you have already created a database user with login credentials

sudo -u postgres createuser -s NAME

To set a password for your new user, first enter the postgres console

sudo -u postgres psql

Then, set the password

\password NAME

You can exit the postgres console via \q

Environment variables

This project uses the dotenv-rails gem to load environment variables. Copy the included .env.sample file to .env and fill in the values for each variable

Install App Dependencies

If you haven't already, install bundler (gem install bundler), then install the dependencies:

bundle install

Install the front-end build dependencies

bin/yarn install

Rake Things

rake db:create
rake db:migrate

Setup Hooks

chmod -R a+x ./scripts
./scripts/dev.local install-hooks

Run the app

To run the app, simply call the startup script!

scripts/startup

What this script does: It simultaneously starts a rails server rails s and runs bin/webpack-dev-server to compile the frontend assets.

Contributing

Testing

Add unit tests for all backend changes you make. Run

rails test

Frontend Setup

If a view isn't dynamic, it's rendered server side, otherwise a react component is used. This project uses the webpacker gem to build all javascript and CSS. The front end source files are located in app/frontend.