template-api

Template Node.js Express API

• getting started
  • cloning and setup
  • development startup
  • api testing
  • starting for production
• auxiliary
• CHANGELOG

getting started

the following applications are required to run in production:

• Node.js (recommended: v12.18.3)
• PM2 (recommended: v4.4.0)

cloning and setup

# clone full-stack template
git clone git@github.com:mi-sec/template-api.git
cd template-api/

development startup

npm i
npm start

api testing

npm i
npm test

starting for production

pm2 start ecosystem.config.js --env production

api will be accessible at http://localhost/api/ by default

auxiliary

API testing:

For testing API things, import the Postman collection in the api folder. Environment should be set for:

• PROTOCOL: http
• HOSTNAME: localhost
• PORT: 80
• PATH: /api

CHANGELOG

v1.0.0

• initial release