argon1025 / muzi-backend Goto Github PK

블로그 체험단 공고 통합 조회 서비스 backend

JavaScript 0.52% TypeScript 98.89% Dockerfile 0.59%

muzi-backend's Introduction

Muzi Back-end

무지 백엔드 서비스
서로 다른 서비스의 맛집, 제품 체험단 공고 통합 조회 제공

Go to Service (2024.05.01 End Service) · View Swagger Doc · Report Bug · Request Feature

Introduce

Built With

NestJS(Express)
TypeScript
PostgreSQL/Prisma
AWS ECS, ECR, ALB, VPC
Github Actions (CI/CD)

Infra

인프라 구성에 대해 설명합니다.

Github Actions를 통해 지속적 배포를 구현합니다.
- PR이 발생할 경우 테스트를 수행합니다.
- main 브랜치에 업데이트가 발생할 경우 Github Actions에서 ECS 배포를 수행합니다.
AWS VPC private, public 서브넷을 통해 중요 인스턴스를 격리합니다.
AWS ECS를 통해 인스턴스를 배포합니다.
- 클러스터 인스턴스는 EC2를 사용합니다.
- 업데이트 배포 시 롤링 업데이트를 사용합니다.

Architecture

서비스별 책임에 대해 설명합니다.

Parsing-event
- 파싱 요청을 관리하는 서비스입니다.
- 동일한 이벤트를 중복으로 발행할 수 없도록 합니다.
- 이벤트 조회 시 점유상태로 설정하여 다른 워커에게 동일한 이벤트가 조회되지 않도록 합니다.
Campaign
- 캠페인 도메인을 관리하는 서비스입니다.
Worker
- 일정 주기로 이벤트를 폴링 하여 요청 타입에 맞게 비즈니스 로직을 호출합니다.

Convention

이슈 관리

Github Projects로 이슈를 생성 및 트래킹 합니다. 링크

브랜치 정책

브랜치를 병합하기 위해서는 반드시 PR을 생성하고 테스트가 통과되어야 합니다.
- PR 생성 시 테스트 자동화 액션이 자동으로 수행됩니다.
각 이슈별로 브랜치를 분리합니다.
- 브랜치 명칭은 {feature|fix}-#{이슈 번호} 로 생성합니다. ex) feature-#19
Main Develop 브랜치는 리니어 하게 관리합니다.
- 핫픽스를 병합할 경우 이력전체를 저장하기 위해 Merge 합니다.
- 개발 브랜치를 병합할 경우 Squash 합니다.
- Main, Develop 간에는 Fast forward를 합니다.
conventionalCommits을 준수합니다

코드 컨벤션

패키지 관리
- 패키지 매니저는 pnpm을 사용합니다.
네이밍
- NestJS에서 사용하는 기본 네이밍 컨벤션을 사용합니다.
코드 스타일
- Airbnb Rule을 사용합니다.
기타
- 최대한 테스트 코드를 작성합니다.
- 요청, 응답에 대해서 DTO를 사용하고 알맞은 Validation 및 직렬화, 역직렬화 프로세스를 거쳐야 합니다
- Service 레이어의 경우 변경에 유연한 구조를 만들기 위해 의존성 역전을 활용합니다.
  - 객체는 하나의 책임만 가져야 하며 GOD 객체를 만드는 행위를 지양합니다.

How To Start

Docker-compose 로컬 개발환경 구성

프로젝트를 시작하기 위해서는 개발 환경이 명시적으로 구성되어있는 Docker-compose를 통해서 로컬 개발환경을 시작할 수 있습니다.

$ cd ./muzi-backend
$ docker-compose up

DB 데이터는 프로젝트 폴더 .environments/docker에 저장됩니다

NodeJS 버전 확인

cat .nvmrc

현재 프로젝트의 노드 버전을 확인할 수 있습니다.

패키지 설치

pnpm i

해당 프로젝트의 기본 패키지 매니저는 pnpm 입니다.

환경설정

.environments/.env.local 에서 로컬 환경설정을 구성할 수 있습니다

# 서비스 설정
NODE_ENV=local
SERVICE_PORT=3000
DATABASE_URL="postgresql://muzi:muzi@localhost:5432/Muzi?schema=public"

# JWT
JWT_ACCESS_TOKEN_SECRET_KEY="secret"
JWT_ACCESS_TOKEN_EXPIRES_IN="15m"
JWT_REFRESH_TOKEN_SECRET_KEY="secret"
JWT_REFRESH_TOKEN_EXPIRES_IN="30d"

# Cookie
IS_HTTP_ONLY_COOKIE=true
IS_SECURE_COOKIE=false
COOKIE_PATH="/"
COOKIE_DOMAIN="localhost"
REFRESH_TOKEN_EXPIRATION_TIME=2592000000 # 30d (milsec)

# KAKAO OAuth
# 앱 > 요약 정보 > 앱 ID
KAKAO_CLIENT_ID=""
# 앱 > 보안 > Client Secret
KAKAO_CLIENT_SECRET=""
# 리다이렉트 URL
KAKAO_REDIRECT_URL="http://localhost:3000/auth/kakao"

환경에 따라 .env.local, env.dev, .env.prod 로 구성합니다.

Prisma Client 생성

$ yarn prisma:migrate:local

이 프로젝트에서는 Prisma로 마이그레이션을 관리합니다

위 명령어를 통해 로컬환경과 마이그레이션 기록을 동기화하고 서버 애플리케이션 실행을 위한 Prisma Client 모듈이 생성됩니다

프로젝트 시작

pnpm start:local

muzi-backend's People

Contributors

Stargazers

Watchers

muzi-backend's Issues

[BackEnd] 아이디 가입, 로그인 기능 추가

이메일 가입
로그인

[BackEnd] 공통 커스텀 로거 추가

HttpService 로깅에 필요한 커스텀로거 추가

데이터베이스, Prisma ORM 구성

PostgreSQL
- Docker-compose 구성
Prisma

[BackEnd] 캠페인 업체 (seoul ouba) 추가 대응

테스트 DB 환경 구성 및 캠페인 서비스 테스트 코드 작성

테스트 DB 구성
테스트 prisma 클라이언트 구성
테스트 스크립트 추가
캠페인 서비스 테스트 코드 작성

[BackEnd] Campaign Parsing 이벤트 스키마 추가

파싱요청 이벤트 저장 스키마 추가

[BackEnd] 파싱이벤트 message 필드 기반 특정 게시글만 업데이트 하는 기능추가

parsing-event message 필드를 사용해서
일괄 업데이트 처리 할지 특정 캠페인만 업데이트할지 업데이트 옵션 제공 필요

[BackEnd] Campaign 조회, 추가, 삭제 기능

캠페인 조회
유저 북마크 캠페인 조회
유저 북마크 캠페인 삭제
유저 북마크 캠페인 추가

[BackEnd] 네이버 소셜 로그인 추가

[Back-end] 로그인 로직 컨트롤러 연동 작업

연동 대상 로직
- 카카오 로그인
Swagger
쿠키 설정
Token Guard, Interceptor
내정보 조회 기능
액세스 토큰 재 발급

[BackEnd] 캠페인 검색 고도화

캠페인 검색 기능 고도화

타이틀
주소
카테고리
현재 모집중인 캠페인만 보기

인덱스 고려 필요

[BackEnd] 로드밸런서 health 체크 API 추가

[BackEnd] 캠페인 프로바이더 검색옵션 추가

캠페인 정보 제공자 필터링 옵션 추가

[BackEnd] 회원 탈퇴 기능 추가

회원탈퇴 API 추가
카카오 연결 끊기 대응 추가

[BackEnd] 캠페인 스키마 컬럼수정 요구사항 반영

스키마

[Unique] 고유 아이디
제목
카테고리 (방문, 배송, 기자단, 기타)
[Optional] 리뷰 타깃 (블로그 인스타)
[Optional] 썸네일 주소
[Optional] 응모 시작일
[Optional] 응모 마감일
[Optional] 당첨자 발표일
[Optional] 도시
[Optional] 주소 상세
[Optional] 총 모집인원
[Optional] 신청 인원
원본 주소

(kakao) 소셜 회원가입

kakao 소셜 회원가입

프로젝트 구성

NestJS
pnpm
node version
Lint Rule
typeScript config

초기 패키지 구성

직렬화 역직렬화
환경설정
파라미터 검증
Swagger
husky (for push)

[BackEnd] 특정 게시글 업데이트 요청 기능

회원 가입된 유저의 경우 특정 게시글을 재 파싱하도록 하는 기능 추가

[BackEnd] ParseEventBatch 기능 추가

파싱 요청 이벤트를 폴링해서
일괄로 이벤트를 처리하는 ParseEventBatch 추가

[BackEnd] 디너의 여왕 파싱 서비스 작성

전체 페이지 색인
캠페인 상세 조회

[BackEnd] GithubAction PR 테스트 리포트 추가

PR 생성 시 Jest 테스트 후 리포트 생성하도록 GithubAction 구성

[BackEnd] ECR 배포 구성

앱 빌드 및 ECR 푸시 플로우 구성
해당 플로우 완료 후 ECS 배포 테스트 진행

[BackEnd] 파싱 시 날짜 UTC로 변환 필요

DB 날짜 UTC로 통합하기 위해
파싱 날짜 데이터도 UTC로 변환 필요

[BackEnd] Campaign UserCampaign 스키마 추가

Campaign

필드명	상세
id
duplicateId	중복 검증 아이디 (고유 조합으로 생성)
resourceProvider	원출처 (강남맛집, 디너의여왕)
target	리뷰 대상 (블로그, 인스타)
category	리뷰 유형 (음식, 제품)
content	상세 내용
resourceUrl	캠페인 주소
city	캠페인 진행 도시
address	캠페인 진행 상세 주소
startedAt	캠페인 신청 시작일
endedAt	캠페인 신청 종료일
drawAt	캠페인 당첨자 발표일
modifyAt	캠페인 수정일
createdAt	캠페인 생성일