- Download this project as a zip.
- Run
npm install
- Run
npm run nodemon:start
- Visit http://localhost:8080/documentation to view swagger docs.
- Visit http://localhost:8080/api/component/{name} to test the REST API.
build-ts
: Compiles typescript based on config set in tsconfig.json.start
: Starts node with the compiled typescript. Used by eg. Heroku.docker:logs
: View Docker logsdocker:ps
: List Docker containersdocker:start
: Start Docker container based on docker-compose.yml file.docker:stop
: Stop Docker containernodemon:build
: Starts the Nodemon using ts-node. No need to compile beforehand.nodemon:start
: Same as nodemon:buildformat:lint
: Runs tslint on the typescipt files, based on tslint.js settings.format:prettier
: Runs prettier on all ts-files.postinstall
: Runs build-ts script. This is used by eg. Heroku automatically.test
: Runs tests using nyc, and creates coverage report.