Skip to content

Latest commit

 

History

History
114 lines (74 loc) · 1.57 KB

README.md

File metadata and controls

114 lines (74 loc) · 1.57 KB
Raw

SchoolSector-api

Get Started

Get started developing...

# install deps
npm install

# run in development mode
npm run dev

# run tests
npm run test

Install Dependencies

Install all package dependencies (one time operation)

npm install

Run It

Run in development mode:

Runs the application is development mode. Should not be used in production

npm run dev

or debug it

npm run dev:debug

Run in production mode:

Compiles the application and starts it in production production mode.

npm run compile
npm start

Test It

Run the Mocha unit tests

npm test

or debug them

npm run test:debug

Try It

  • Open you're browser to http://localhost:3000
  • Invoke the /examples endpoint 
    curl http://localhost:3000/api/v1/examples

Debug It

Debug the server:

npm run dev:debug

Debug Tests

npm run test:debug

Debug with VSCode

Add these contents to your .vscode/launch.json file

Lint It

View airbnb linter output

npm run lint

Fix all airbnb linter errors

npm run lint

Railway Deployment

If the build fails because it could not authenticate the Postgres password on Ralway deployment, add DATABASE_URL to the Variables on the dashboard to overwrite it.

Library

  • Sequelize: ORM database model
  • Express: Http Server
  • S3 : Static Files
  • Passport: Authentication and Auth0