Sail Back

Membership management system for Friends of Chichester Harbour.

Run

In order to start the app you need a MySql database running on localhost for more details see config. (You will need to create database foch_testing)

Once the database server is running you can run the app with:

git clone https://github.com/foundersandcoders/sail-back
npm install
npm run dev

File Structure

/
  assets/ <--- public static files
    styles/
    images/
  api/
    controllers/ <--- endpoint logic
    models/ <--- data shapes
    policies/ <--- permissions
    queries/ <--- SQL queries
  config/
    routes/  <--- mapping routes to handlers
  test/
    backend/
    laws/ <--- property testing for redux modules with jsverify
  views/
  server.js
  package.json
  ...

Flow

Flow is no longer being utilized in the test script.

Database backup Documentation in /scripts/db/

Q & A

Where shall I focus my attentions?

Most of the action is in src/admin/redux/modules There is also a little bit of action spread throughout api/controllers

Isn't the code a bit weird?

Yes in places it is. It will seem a bit less weird if you look at

• The Mostly Adequate Guide
• Ramda
• Sanctuary

But perhaps the best place to start is Underscore You're Doing it Wrong