Nestjs Template

This project is a boilerplate for Nestjs projects.
Explore the docs | Explore lucid charts

Build with

• NestJS
• TypeScript
• Typeorm
• MySQL
• RabbitMQ

Getting Started

Prerequisites

Make sure you have the following installed:

• Node (at least the latest LTS)
• Yarn (at least 1.0)
• Docker and Docker Compose (if you want to use the docker-compose file)

Make sure you have the .env file in the root of the project.

• You can ask one from the fellow developers or create your own using the .env.example as a reference.

Does not depend on any other services from SB to work.

Starting Database

Start MYSQL and RabbitMQ services before running the server.

# from the project root
docker-compose -f docker/docker-compose.yml up -d database rabbitmq

Dependencies

Node dependencies

# from the project root
yarn

Database Migration

# To run the migrations
make migrate

# To revert the migrations
make revert-migration

# To generate a new migration
make generate-migration name="migration-name"

Running Tests

# from the project root
yarn test

Starting the server

# from the project root
yarn start:dev