djoksimo/srvice-api

The Srvice Node/Express.js API

Srvice HTTP API (archived)

The Srvice Node/Express.js API

Engineering Docs

NOTE: the Srvice API is only stable for node versions 12.x

Getting Started:

1. Make sure you have Node.JS v12+ installed
2. $ npm install in api folder
3. $ npm run dev

Testing:

• $ npm test

Available NPM Scripts

Lifecycle scripts included in srvice-api:

  test
    nyc --reporter=text-summary mocha src/test/index.js --timeout 10000 --exit
  posttest
    echo Srvice API passed all tests 🎉
  start
    nodemon

e.g $ npm run dev

Available via npm run <script-name>:

  coverage
    nyc --reporter=lcov mocha src/test/index.js --timeout 10000 --exit
  build
    pm2 start src/index.js
  lint
    npx eslint src/* --color --quiet
  gen
    node src/mock/CLIGen.js
  prettier
    prettier --config \"./.prettierrc\" --check \"./src/**/*.{ts,json}\"
  autofix  <-- use this to avoid CI errors!!!
    prettier --config "./.prettierrc" "./src/**/*.{ts,json}" --write ; eslint ./src/**/*.ts --color --quiet --fix

e.g $ npm run gen

Main Resources

1. Getting Started
2. File/Folder Structure
3. Srvice Git Guidelines
4. Srvice API Docs
5. Linting & Code Style Guidelines
6. Troubleshooting

Other Resources:

• Engineering Docs
• Srvice StackOverflow
• Google