sindra-management-api v1.0.0

Description

NestJS Boilerplate made with ❤️ by 💡Sindra💡.

Installation

$ npm install

Running the app

# development
$ npm run start:dev

# watch mode
$ npm run start:watch

# incremental rebuild (webpack)
$ npm run webpack
$ npm run start:hmr

# production mode
$ npm run start

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Environment Configuration

Integrated Configuration Module so you can just inject ConfigService from package nestjs-config and read all environment variables from .env file. Don't forget to make your own .env file!

Swagger

RESTful APIs you can describe with already integrated Swagger. To see all available endpoints visit http://localhost:5000/swagger

TypeORM integrated

TypeORM gives you possibility to use next db types: mysql, postgres, mariadb, sqlite, etc. Please look at docs for more details. We have provided working example with sqlite, but you have possibility to change this through ormconfig.json. By default you will get sqlite-example.sql file created in the root directory, but it's ignored by git.

Authentication - JWT

Already preconfigured JWT authentication. It's suggested to change current password hashing to something more secure. You can start use already working implementation of Login and Registration endpoints, just take a look at http://localhost:5000/swagger.

License

NestJS Boilerplate is MIT licensed.