NODE TEMPLATE (Javascript)

This is a flexible, and generic node.js/express template which covers most basic to advance needs of modern REST APIS.

DEPENDENCIES

The template comes with the following dependencies defined:

• compression - https://github.com/expressjs/compression#readme
• cors - https://github.com/expressjs/cors#readme
• dotenv - https://github.com/motdotla/dotenv#readme
• helmet - https://helmetjs.github.io/
• mongoDB - https://www.mongodb.com/
• mongoose - https://mongoosejs.com/
• morgan - https://github.com/expressjs/morgan#readme
• winston - https://github.com/winstonjs/winston#readme

DEV DEPENDENCIES

• eslint - https://eslint.org/
• nodemon - https://github.com/remy/nodemon

TESTING DEPENDENCIES

• chai - http://chaijs.com/
• mocha - https://mochajs.org/
• nyc - https://istanbul.js.org/
• proxyquire - https://github.com/thlorenz/proxyquire#readme
• sinon - https://sinonjs.org/

CONFIGURATION

1. Install dependencies.

   npm i

2. create the following environment variables:

   • NODE_ENV: specifies the working environment
   • APP_PORT: Sets a default app port.
   • APP_DB_URI: Sets a default Mongo DB connection URI.

3. Be awesome.

LICENSE

• ISC - https://www.isc.org/licenses/