📋 TypeScript and NodeJS project template.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
db-scripts
src
test
.editorconfig
.gitignore
.nvmrc
.travis.yml
Dockerfile
LICENSE
README.md
docker-compose.yml
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

typescript-node Build Status codecov Codacy Badge

Template for building nodejs and typescript services. The main goal of this boilerplate is to offer a good Developer Experience (eg: debugging, watch and recompile) by providing the following features out of the box:

Features

Installation & Run

  • npm install - Install dependencies
  • npm run start - Start application (It needs a mysql database)

Running with Docker

  • docker-compose up (compose and run, it also creates the mysql database)
  • docker-compose down (Destroy application and mysql containers)

Useful npm commands

  • npm run build - Transpile TypeScript code
  • npm run clean - Remove dist, node_modules, coverage folders
  • npm run coverage - Run NYC coverage
  • npm run lint - Lint your TypeScript code
  • npm run start:dev - Run application in dev mode (debug & watch). Debug mode is running on port 5858 (open chrome://inspect/#devices).
  • npm run test - Run unit tests
  • npm run test:integration - Run integration tests
  • npm run test:all - Run Unit and Integration tests