- Git clone the repo
git clone [url]
and remove origingit remote remove origin
- npm install the packages
npm install
- Configure development database. If using postgresql create a new psql database in terminal and change reference (see knexfile.js for instructions)
- Run knex database migrations
npm run bootstrap
- Start server
npm run dev
- Create your own database tables by rolling back knex migrations
knex migrate:rollback
then creating new migrationknex migrate:make newtables
, configure knex table (see migraiton folder for exmaples or visit knex website), then migrateknex migrate:latest
- Change relevant seed files, models, routes and controllers
- Write tests in the test folder and run mocha in terminal to test files
Configuration is stored in .env files are used for storing configuration. Follow .env.example for usage.