설명

• NestJS기반으로 운영되는 모임(Crew) 서버
• PlayGround Link
• PlayGround Dev Link

node_modules 설치

npm ci

실행하는 법

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

테스트

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

배경

• Crew 서비스는 사람들을 모으고 융합하는 데에 목적을 두고있습니다.
• Crew 서비스는 Playground와 같은 Front-end Domain으로 운영되고 있지만, 서버는 Crew와 Playground를 분리하여 운영하고 있습니다.
• PlayGround에서 발급하는 token을 가져와서 Playground 사용자의 정보를 이용해 Crew의 사용자로 재등록하고 있습니다.

기술스택

• DB: PostgreSQL
• DB GUI tool: pgAdmin4
• ORM: TypeORM
• API 문서: Swagger
• 배포: AWS EC2, Docker Compose
• 인증: JWT
• 테스트: Jest, Unit5
• 서버 프레임워크: NestJS, Spring
• 웹서버 프레임워크: Caddy
• 언어: typescript, Java

아키텍처

flow

1. Caddy를 통해 HTTPS를 적용하고, HTTP로 들어오는 요청을 HTTPS로 리다이렉트한다.
2. HTTPS로 들어온 요청을 Caddy가 받아서, Caddy는 요청을 받은 후에 해당 요청을 NodeJS/Spring 서버로 리버스프록시한다.
3. NodeJS/Spring 서버는 요청을 받아서, 요청에 맞는 Controller를 찾아서 해당 Controller에서 Service를 호출한다.
4. Service에서 로직을 처리한 후에, Repository를 통해 DB에 접근한다.
5. Repository는 DB에 접근해서 데이터를 가져온 후에, Service에게 데이터를 전달한다.
6. Service는 Repository로부터 받은 데이터를 가공해서 Controller에게 전달한다.
7. Controller는 Service로부터 받은 데이터를 가공해서 Client에게 전달한다.

프로젝트 디렉토리 구조

.
├── Dockerfile # docker로 배포할 때 사용하는 파일. 현재는 사용하지 않음
├── jest.config.ts
├── nest-cli.json
├── package-lock.json
├── package.json
├── src
│   ├── app.module.ts # 모든 모듈을 import하는 모듈
│   ├── auth # 인증 관련 모듈
│   ├── common # 여러 모듈에서 공통적으로 사용하는 코드들을 관리
│   │   ├── constant # constant 관리
│   │   ├── decorator # decorator 관리
│   │   ├── dto # dto 관리
│   │   ├── enum # enum 관리
│   │   ├── interceptor # interceptor 관리
│   │   ├── pagination # pagination 관리
│   │   └── utils # utils 관리
│   ├── db # DB 관련 모듈
│   ├── entity # DB entity 관리
│   │   ├── apply # 모임 신청 관련 entity
│   │   ├── meeting # 모임 관련 entity
│   │   ├── notice # 공지사항 관련 entity
│   │   └── user # 사용자 관련 entity
│   ├── health # health check 관련 모듈
│   ├── internal-api # Makers 내부 API 관련 모듈
│   ├── main.ts # NestJS의 entry point
│   ├── meeting # 모임 관련 모듈
│   ├── notice # 공지사항 관련 모듈
│   ├── shared # 여러 모듈에서 공유하는 모듈
│   └── user # 사용자 관련 모듈
├── test # test 관리
│   ├── e2e # e2e test 관리
│   ├── integration # integration test 관리
│   └── unit # unit test 관리
├── tsconfig.build.json # build를 위한 typescript 설정
├── tsconfig.json # typescript 설정
└── typings # type 관리
    └── global.d.ts # 전역으로 사용할 type 관리

모듈 디렉토리 구조

도메인 모듈 디렉토리 구조

foo # 예시 모듈
├── foo.module.ts # 모듈 entry
└── v${버전} # 버전별로 디렉토리를 나눠서 관리
    ├── dto # dto 관리
    │   ├── foo-v${버전}-${호출하는 함수 명} # 호출하는 함수 명에 따라 디렉토리를 나눠서 관리
    │   │   ├── foo-v${버전}-${호출하는 함수 명}-query.dto.ts
    │   │   ├── foo-v${버전}-${호출하는 함수 명}-response.dto.ts
    │   │   ├── foo-v${버전}-${호출하는 함수 명}-headers.dto.ts
    │   │   └── foo-v${버전}-${호출하는 함수 명}-body.dto.ts
    ├── interface # interface 관리
    │   └── foo-v${버전}-${interface명}.interface.ts
    ├── type # type 관리
    │   └── foo-v${버전}-${type명}.type.ts
    ├── constant # constant 관리
    │   └── foo-v${버전}-${constant명}.constant.ts
    ├── enum # enum 관리
    │   └── foo-v${버전}-${enum명}.enum.ts
    ├── ...
    ├── foo-v${버전}.controller.ts # controller 관리
    ├── foo-v${버전}.module.ts # module 관리
    └── foo-v${버전}.service.ts # service 관리

• Controller: 요청을 받아서, Service를 호출한다.
• Service: Entity Module의 Repository나 Internal Module을 호출해서 로직을 처리한다.
• 기타 enum, type, interface 등은 해당 모듈 안에서만 쓰이는 경우에 모듈 내부에서 관리한다.

엔티티 모듈 디렉토리 구조

bar # 예시 모듈
├── bar.entity.ts # entity 모델 관리
├── bar.repository.ts # entity repository 관리
└── enum # enum 관리
    └── bar-${enum명}.enum.ts

• entity: DB entity를 관리한다. DB entity는 DB의 테이블과 1:1로 매칭된다.
• repository: DB entity에 접근하는 로직을 관리한다. 순수하게 하나의 entity만 접근하는 로직이어야 한다.
• 기타 enum, type, interface 등은 해당 모듈 안에서만 쓰이는 경우에 모듈 내부에서 관리한다.

개발

환경 변수

• 환경 변수는 dev/prod 환경에 따라 다르게 설정되어야 한다.
  • Nestjs
    • dev 환경: .dev.env
    • prod 환경: .prod.env
  • Spring
    • dev 환경: application-dev.yml
    • prod 환경: application-prod.yml
    • application-secret.properties: secret key를 관리한다.

API 문서

• /api-docs로 접속하면 볼 수 있다.
• Crew API Docs - Dev
• Crew API Docs - Prod
• Playground API Docs - Dev

인증

• auth 디렉토리에 참조
• Playground에서 accessToken을 발급하면, 해당 accessToken을 받아서 Playground API에 요청 후 해당 결과를 Crew DB에 저장.
• 회원가입이 존재하지 않음
• Dev환경에서 accessToken을 확인하는 방법

배포

배포 전략

• 현재는 수동배포를 진행중이고 Blue-Green 방식의 배포를 진행하고 있지 않는다.
• 수동배포 이후 짧은 순단(서버 재시작)이 발생하기 때문에 새벽에 배포를 하거나, 사용자가 몰리는 시간대는 피해서 배포를 진행한다. (Prod환경 기준)
• Prod환경의 경우는 main 브랜치를, Dev환경의 경우는 develop 브랜치를 기준으로 배포를 진행한다.

배포 정보

• 배포 서버: AWS EC2
• 배포 툴: Docker Compose

배포 방법

# Prod 배포
$ sudo docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build

# Dev 배포
$ sudo docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

# 배포 후 로그 확인
$ sudo docker compose logs -f -t 10

# 배포 후 컨테이너 상태 확인
$ sudo docker compose ps -a

# 배포 후 사용하지 않는 이미지 자동 삭제
$ sudo docker image prune

협업

Git

1. 이슈를 생성한다.
2. 이슈를 기반으로 브랜치를 생성한다.
   • ex: feature/crew-1
3. 브랜치를 생성한 후에 작업을 진행한다.
4. 진행한 후에 커밋을 한다.
5. 작업이 완료되면 PR을 생성한다.
6. PR을 생성한 후에 팀원들에게 리뷰를 요청한다.
7. 리뷰를 받은 후에 PR을 develop에 merge한다.
8. develop에 merge된 후에 develop환경 배포를 진행한다.

커밋 컨벤션

TBD