Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1 KB

README.md

File metadata and controls

18 lines (15 loc) · 1 KB
Raw

project-vanilla-pudding-server

Node.js api server for project-vanilla-pudding

Getting Started

  1. npm install to install all dependencies.
  2. Create a shell script to store your secret keys. If you call it secret.sh then env.sh will automatically source it when it runs. You'll need to define the following variables:
    • EXPRESS_SECRET_KEY
  3. source env.sh to set up your dev environment -- IMPORTANT the server won't run unless environment variables are set correctly, so sourcing this script is required.
    • Remember to add the filename of your secrets file if you're not using secret.sh.
  4. npm install knex -g (/w sudo if needed) to install the knex cmd-line client.
  5. knex migrate:latest to migrate to the latest version of the database.
  6. Get tests and code coverage up and running.
    • npm install mocha -g
    • npm install istanbul -g
    • npm test to test your changes. This runs the istanbul code coverage tool as well as the mocha test runner.

[more steps coming soon]