NestJS Boilerplate

A very simple starter template for NestJS projects using TypeORM, with Swagger API description and unit tests coverage.

• List users.
• Show user.
• Create users.
• Update users.
• Delete users.

Tech

Technologies used in this project:

• NestJS - A progressive Node.js framework.
• TypeScript - TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
• TypeORM - ORM for TypeScript and JavaScript (ES7, ES6, ES5).
• Swagger - OpenAPI (Swagger) module for Nest framework (node.js).
• PostgreSQL - PostgreSQL is a powerful, open source object-relational database system.

And of course NestJS itself is open source with a public repository on GitHub.

Installation

Clone the repository:

git clone [email protected]:flads/nestjs-boilerplate.git

Install the dependencies:

cd nestjs-boilerplate && npm i

Create your .env file:

cp .env.example .env

Configure your database credentials...

Run migrations:

npm run typeorm migration:run -- -d ormconfig.ts

Start the server:

npm run start:dev

Swagger

Access the API description at http://127.0.0.1:3000/swagger.

Development

Want to contribute? Great! Feel free!

License

MIT