Global Dependencies

node, npm, sequelize-cli, mocha

Requirements

PostgreSQL database (Postgres.app is good for local testing on a Mac)

Setup

git clone https://mikecoram@bitbucket.org/mikecoram/prepare.git
npm install
npm install -g sequelize-cli mocha

Set up a postgreSQL database and then edit config/config.json to point to the database. Change the admin details in 'seeders/*-init.js' Initialise the database:

sequelize db:migrate
sequelize db:seed:all

Sequelize

Creating a new model (generates model and migration):

sequelize model:create --name Name --attributes "attr:type, attr2:type"

Apply all migrations

sequelize db:migrate

Undo last migration

sequelize db:migrate:undo

Undo all migrations

sequelize db:migrate:undo:all

Apply all seeders

sequelize db:seed:all

Undo all seeders

sequelize db:seed:undo:all

Create new seeder

sequelize seed:create

Notable

Edit config/config.json to configure database and email settings Edit app name etc. in lib/locals.js Create a credentials.json file in the config folder like so:

{
    "cookieSecret": "your cookie secret"
    "sessionSecret": "your session secret",
}

Constants are stored in constants.js including User roles enum

Running

npm start

Testing

npm test