nestjs-microservices-example - GitLite

KO | EN

gitlite — search

#javascript #ai #typescript #rust #deep-learning #linux #macos #windows #kubernetes #awesome-list #vue #pytorch #openai #open-source

nestjs-microservices-example

(★ 996)

A working example of microservice architecture implementation using nestjs framework.

File Explorer

Download Latest Version (.zip)

- - create-user.sh
- .gitkeep
- - app.module.ts
  - main.ts
  - tasks.controller.ts
  - users.controller.ts
- - config.ts
  - jest-e2e.json
  - task.e2e-spec.ts
  - timeout.ts
  - user-confirm.e2e-spec.ts
  - user-sign-in.e2e-spec.ts
  - user-sign-out.e2e-spec.ts
  - user-sign-up.e2e-spec.ts
- .dockerignore
- .eslintrc.js
- .prettierrc
- Dockerfile
- nest-cli.json
- package.json
- tsconfig.build.json
- tsconfig.json
- tslint.json
- - mailer.controller.ts
  - mailer.module.ts
  - main.ts
- .dockerignore
- .eslintrc.js
- .prettierrc
- Dockerfile
- nest-cli.json
- package.json
- tsconfig.build.json
- tsconfig.json
- tslint.json
- - main.ts
  - permission.controller.ts
  - permission.module.ts
- .dockerignore
- .eslintrc.js
- .prettierrc
- Dockerfile
- nest-cli.json
- package.json
- tsconfig.build.json
- tsconfig.json
- - main.ts
  - task.controller.ts
  - task.module.ts
- .dockerignore
- .eslintrc.js
- .prettierrc
- Dockerfile
- nest-cli.json
- package.json
- tsconfig.build.json
- tsconfig.json
- - main.ts
  - token.controller.ts
  - token.module.ts
- .dockerignore
- .eslintrc.js
- .prettierrc
- Dockerfile
- nest-cli.json
- package.json
- tsconfig.build.json
- tsconfig.json
- - main.ts
  - user.controller.ts
  - user.module.ts
- .dockerignore
- .eslintrc.js
- .prettierrc
- Dockerfile
- nest-cli.json
- package.json
- tsconfig.build.json
- tsconfig.json
.env.example
.env.test.example
.gitignore
docker-compose.test.yml
docker-compose.yml
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/Denrox/nestjs-microservices-example

Downloads the entire project code from GitHub to your computer.

cd nestjs-microservices-example

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f docker-compose.test.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd gateway

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# This repository shows how you can build API with microservice architecture using nestjs
## Features of this example
This example is basically an API for some task manager application. It provides a possibility to perform sign up users, confirm user's emails, manage user's tasks.
## Running the example with docker-compose
Execute `docker network create infrastructure && cp .env.example .env && docker-compose up -d` from the root of the repository
## Accessing the API itself and swagger docs for the API
- Once you launch the API it will be accessible on port 8000.
- Swagger docs for the API will be accessible locally via URI "**http://localhost:8000/api**"
## Launch services for integration testing (using docker-compose)
- Execute `sudo vim /etc/hosts` and add line `127.0.0.1 db` to it. This is a temporary step, it will not be required since new update.
- Execute `cp .env.example .env && cp .env.test.example .env.test`
- Execute `docker-compose -f ./docker-compose.test.yml up -d` from the root of the repository
- Run `cd ./gateway && npm install && npm run test` from the root of this repo
## Brief architecture overview
This API showcase consists of the following parts:
- API gateway
- Token service - responsible for creating, decoding, destroying JWT tokens for users
- User service - responsible for CRUD operations on users
- Mailer service - responsible for sending out emails (confirm sign up)
- Permission service - responsible for verifying permissions for logged in users.
- Tasks service - responsible for CRUD operations on users tasks records
- The service interact via **TCP sockets**

This example uses a SINGLE database (MongoDB) instance for all microservices. **This is not a correct point, the correct way is to use a separate DB instance for every microservice.** I used one DB instance for all microservices to simplify this example.