/superhero

Super Hero Catalogue REST api

Primary LanguageHTML

superhero

Super Hero Catalogue REST api

Description

  • Koa 2.x
  • Asynchronous Functions (Async/Await)
  • Compress, Cors
  • Json Web Token
  • HTTP
  • Mongodb
  • Mongoose
  • Mocha and Chai
  • nyc
  • SSE Broadcast

Running

Install dependencies

npm install

Start Seed to populate Users, SuperPowers and SuperHeroes in MongoDB

npm run seed

** Note : Please make sure your MongoDB is running before using npm run seed **

Start a Local Server

npm start

** Note : Please make sure your MongoDB is running before using npm start **

Run Test

npm test

Generate Code Coverage Report

npm run coverage

** Note: After execute command, open report in /coverage/lcov-report/index.html **

Generate Doc's

npm run docs

** Note: After execute command, open report in /docs/index.html **

License

MIT © sfiorotti