nestjs-microservices-example - GitLite

KO | EN

gitlite — search

#react #typescript #llm #go #golang #android #rust #nodejs #java #windows #awesome #kubernetes #awesome-list #ios

nestjs-microservices-example

(★ 996)

A working example of microservice architecture implementation using nestjs framework.

파일 탐색기

최종 버전 다운로드 (.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

# 설치 가이드

1. 코드 내려받기

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

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd nestjs-microservices-example

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

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

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd gateway

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// 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.