Overview
NestJS-RESTFUL-API-STARTKIT is a full-stack TypeScript solution, and starter project. It is intended for developers who are looking to fast-track building a strongly typed, enterprise-grade, modern NodeJs application, with supporting tooling.
This implementation uses the BFF pattern, leveraging NestJS as the primary framework for the backend. Features include production grade logging, authorization, authentication and mysql migrations.
Installation
$ npm install
Config
- Rename the file
.env.sample
to.env
in the project root. - Config the database info in
.env
.
Running the app
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
Test
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov