/bibapi

Express api for "Bring it Back" website

Primary LanguageJavaScriptBSD 2-Clause "Simplified" LicenseBSD-2-Clause

bibapi

bibapi

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 prettier linter output

npm run lint

Fix all prettier linter errors

npm run lint

Deploy It

Deploy to CloudFoundry

cf push bibapi