rokket-labs / nestjs-template

Nest.js template for backend projects

Home Page:nestjs-template-git-master.tomcastro.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nest Logo Rokket Logo

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular. This template helps you start new applications, as used by Rokket Labs 🚀.

NPM Version Package License NPM Downloads Travis Linux Coverage Gitter Backers on Open Collective Sponsors on Open Collective

Description and Features

Nest framework TypeScript starter repository. It includes the following:

  • Rokket Labs ESLint and Prettier preconfigured and ready to go!
  • Dockerfile and Docker-Compose for easy deployment. Includes Terminus health checks for Kubernetes deployment.
  • Express, Typegoose and GraphQL configuration out of the box.
  • Socket.io (with Redis) and Email integration.
  • Authentication (Passport and JWT) and Authorization (Roles and Guards) example.
  • Working example with Users, Orders and Items, complete with schemas, tests and resolvers.
  • Built with NestJS coding standards and suggestions.

Installation

$ yarn

Running the app

First, copy the .env.example file to .env and fill out your environment variables. Then, run the following commands:

# MongoDB and Redis
$ docker-compose up -d --build redis mongo

# Build and watch the server
$ yarn build

# On a different terminal window, run the server in development mode
$ yarn start

# or in production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

How to contribute

If you'd like to contribute to this template, your help is more than welcome! :feelsgood:

Local testing

Fork this repository, clone it, and start a new app. After you tested your changes, create a PR to the develop branch.

Pull requests and Issues

PR's and issues are a great contribution for us, and we'll get to them as fast as we (humanly 🤖) can. Please create your pull requests from your own fork, and if you're raising an issue, try to be as descriptive as possible so we can zap those pesky bugs ⚡.

License

Nest is MIT licensed.

About

Nest.js template for backend projects

nestjs-template-git-master.tomcastro.vercel.app


Languages

Language:TypeScript 98.1%Language:Dockerfile 1.3%Language:Shell 0.4%Language:JavaScript 0.2%