deryfebriantara / nestjs-kitchensink

NESTJS Starter Project

Nestjs Kitchensink

nestjs Kitchensink is a nestjs starter project, probably will make you save one hour coding to start a project.

Installation

make sure you have nestjs installed on your local machine nest doc to install nestjs.

$ npm i -g @nestjs/cli
$ git clone [e-mail]:deryfebriantara/nestjs-kitchensink.git
$ cd nestjs-kitchensink
$ touch .env 
$ yarn install

Usage

edit .env file with following code, this project using mysql by default if you want changing database type the configuration in src/shared/services/database-connection.service.ts

DATABASE_HOST = "localhost"
DATABASE_PORT = 3306
DATABASE_USER = "root"
DATABASE_PASSWORD = "your_pass"
DATABASE_DB = "your_db"

and you are ready to go

$ yarn start:dev

open localhost:3000/api/docs

Packages

• nestjsx/crud documentation
• authentication with passport and jwt strategy documentation
• OpenApi nestjs/swaggerdocumentation
• example todo CRUD operation using nestjsx/crud
• TypeOrm documentation

Run test

$ yarn test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT