rojiwon123 / bbs

Bulletin Board System

NestJS Bulletin Board System

Table of Contents

1. 소개
2. API 문서화 방식
3. 요구사항
4. ERD 문서
5. Swagger UI
6. 커밋 컨벤션

소개

NestJS 기반의 전자 게시판(BBS) API 서버

특징

• type-safe
• 시나리오 테스트 코드 보유
• ERD/API 문서 자동화

API 문서화

• swagger, sdk 빌드 명령어

npm run build:nestia

• swagger-ui 서버 실행

npm run swagger

요구사항

필수 사항

• 소셜 간편 로그인
• 게시글 변경이력 저장
• 게시글 첨부파일 제공
• 위지윅 에디터 연동

추가 사항

• 권한 관리(비공개 게시판)
• 소셜 간편가입 추가 프로세스
• 임시 게시글 저장

커밋 컨벤션

1. 유다시티 컨벤션을 기반으로 깃모지를 활용한 깃 컨벤션을 적용한다.

• 유다시티 스타일 설명 블로그

• 깃모지 설명 블로그

컨벤션 표기 예시

Udacity	Gitmoji	emoji	description
feat	✨	✨	기능 추가
fix	🐛	🐛	버그 수정
hotfix	🚑	🚑	긴급 수정
(hot)fix	🔒	🔒	보안 이슈 해결
docs	📝	📝	문서 업데이트
style	🎨	🎨	코드 구조, 포매팅 관련 수정
style	🚚	🚚	리소스 이동, 이름 변경
refactor	♻️	♻️	프로덕션 코드 리팩토링
test	✅	✅	테스트 추가/수정
chore	⬆️	⬆	dependencies 업데이트
chore	👷	👷	CI 빌드 시스템 추가/수정
chore	🔧	🔧	설정 파일 추가/수정
chore	➕	➕	dependency 추가
chore	➖	➖	dependency 제거
chore	🗃️	🗃️	DB 관련 수정 사항 적용
release	🔖	🔖	새로운 버전 출시

Appendix

• Nestia 공식 가이드
• Typia 공식 가이드
• prisma-markdown

bbs's Issues

✨ 게시글 파일 첨부 지원

목표

게시글에 첨부파일을 달 수 있게 개선한다.

✨ 나의 활동 모아보기 지원

• 내가 작성한 게시글 모아 보기
• 내가 작성한 댓글 모아 보기

✨ 게시판 매니저 API 추가

게시판 매니저용 공지글 생성, 게시글 수정/삭제 API 추가

✨ 게시판 시스템 도입

목표

• 게시글에 소속을 부여한다.
• 게시판 기준으로 게시글들을 검색할 수 있다.
• 게시판 단위로 게시글 및 댓글에 대한 권한 검사를 추가한다.

권한 체계

1. 서비스는 여러 권한 그룹을 생성한다.
2. 게시판은 특정 액션에 대해 허용 그룹을 지정한다.
3. 모든 사용자는 하나의 특정 그룹에 속한다. (일종의 계급)
4. 사용자의 소속 그룹이 허용된 그룹인 경우에 액션을 수행할 수 있다.
5. 사용자의 소속 그룹이 없을 수도 있으며 이는 비회원과 동일한 권한을 부여한다.
6. 게시판이 null 그룹에 대해 액션을 허용하면 비회원 혹은 (그룹이 없는)미인증 회원은 해당 액션을 수행할 수 있다.
7. 쓰기 작업은 필수적으로 회원만 가능하다.(만약 null 그룹에 대해 쓰기를 허용하면, 비회원은 쓸 수 없고 미인증 회원은 쓸 수 있다.)

✨ 채널 시스템 도입

• 모든 게시판 서비스는 특정 채널 하나에 속한다.
• 모든 게시판, 게시글, 댓글은 채널단위로 구분된다.
  즉, 채널은 독립적인 게시판 서비스를 의미한다.
  e.g., 애브리타임에서 "세종대학교"와 "건국대학교" 같은 관계

(전체 채널에서 핫이슈 게시물 등등을 모아보는 api를 별도로 개발도 고려)

♻️ API 리팩토링

목표

더 확장성있는 API 설계
-> 현재 api 설계방식은 "내 게시글", "인기글" "최신글" 불러오기 등등을 구현할 때, 일관성이 떨어질 것 같다.

테스트 리팩토링

✨ AWS Cognito 적용

✨ 대댓글 지원