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