https://github.com/georgianstan/nestjs-microservice-boilerplate

Boilerplate for a TCP Microservice in NestJS with TypeORM and tests
https://github.com/georgianstan/nestjs-microservice-boilerplate

boilerplate database mariadb-mysql nestjs nestjs-microservices nestjs-typeorm tcp

Last synced: 24 days ago
JSON representation

Boilerplate for a TCP Microservice in NestJS with TypeORM and tests

• Host: GitHub
• URL: https://github.com/georgianstan/nestjs-microservice-boilerplate
• Owner: GeorgianStan
• Created: 2020-02-01T12:16:29.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-29T07:26:17.000Z (over 3 years ago)
• Last Synced: 2023-03-04T11:48:28.335Z (almost 2 years ago)
• Topics: boilerplate, database, mariadb-mysql, nestjs, nestjs-microservices, nestjs-typeorm, tcp
• Language: TypeScript
• Homepage:
• Size: 232 KB
• Stars: 45
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Changelog

### v2.1.0

- sample `.env` file to indicate required environment variables

- switch to truly private variables, instead of TypeScript modifiers

- `CustomResponse` interface includes the `namespace` now

## v2.0.0

### Core

- **upgrade** to latest **NestJS** version(v7)

- folder structure update

- use `cross-env` to set the `NODE_ENV` for cross OS support

### Modules

- refactor `utils` to simply `custom-response`

- `CustomResponse` interface is a generic now

- new custom-response status `WARNING = 'warning'`

- `config.service` will use now `process.cwd()` istead of a relative path

- `config.service` will return the values from `.env` files or from `process.env`

- `database.module` will receive each entity inside the `entities` instead of `'dist/**/*.entity{.ts,.js}'`

---

### Explanation

For a better understanding, check out this [article](https://itnext.io/nestjs-microservice-with-typeorm-mariadb-and-integration-e2e-testing-379338e99580).

# Preparation

- install the desired database, this example is made with **MariaDB** [link to a youtube tutorial](https://www.youtube.com/watch?v=hDKnsUrz0nM&t=195s)

- install Pachet Sender (like Postman for TCP) [download link](https://packetsender.com/)

- download the code and run `npm i`

# Write your .env variables

Now is time to write your configuration for this project. Create two files: _.env.development_ and _.env.test_.

**!** Both will be ignored with _.gitignore_

**!** In production instead of these two, create a new file on your server named _.env.production_

This is an example for _.env.development_

**! Replace with your config**

```

DB_SERVER_PORT=3306

DB_SERVER_HOST=localhost

DB_SERVER_USERNAME=root

DB_SERVER_PASSWORD=root

DATABASE=users

ERROR_CODE_NAMESPACE=users-microservice

```

# Microservice Port

**:8875**

# Response Format

```

{

  "status":ResponseStatus

  "data":any -> '' when no data is found

  "error":CustomError

}

```

**ResponseStatus** - "success" or "fail"

**CustomError** - consist of 3 parts: an error code, a message and a namespace. Codes are universal, but messages can vary. Here is the error JSON payload:

```

{

  "code":number,

  "msg":string || string[]

  "namespace":string

}

```

# Error codes

## 10xx - General Server or Network issues

**1000 UNKNOWN**

- An unknown error occured while processing the request.

**1001 DATABASE_ERROR**

- An unknown error occured on database.

## 11xx - Request issues

**1100 BAD_PARAMETERS**

- Bad parameters send to endpoint

- The validation pipe will return the error as message