API

node npm version

API starter-kit for ASI projects

TECH

  • ExpressJS - is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
  • MongoDB - is a giant leap forward that helps organizations standardize on a single, modern database for their new, mission-critical applications.
  • Mongoose - elegant mongodb object modeling for node.js
  • CoffeeScript - is a little language that compiles into JavaScript. Underneath that awkward Java-esque patina, JavaScript has always had a gorgeous heart. CoffeeScript is an attempt to expose the good parts of JavaScript in a simple way.
  • Mocha - is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
  • Supertest-as-Promised - Supercharged supertest with a promise interface
  • Mongoose-Seeder - MongoDB seeder
  • Lusca - Application security for express apps.
  • Q - Promise Library
  • Docker - is the world's leading software containerization platform

SCRIPTS

Default

Executes API under specific port and under development environment. Also including nodemon for development purposes

npm start

Debug

Executes API under specific port and under development environment. Also including node-debug for debugging purposes

npm run debug

Development

Executes API under specific port and under development environment. Also including nodemon for development purposes

npm run start:dev

Production

Executes API under specific port and under production environment. Without the use of nodemon for production purposes

npm run start:prod

Testing

Executes MochaJS unit-test

npm test | npm run test

Linting

Executes ESLint for code verification

npm run lint

DOCKER

Compose

Executes Docker compose. please refer to docker-compose.yml

docker-compose up