MUMENT-SERVER

Contributors

hujumee	kimchaeeun3447
DB 스키마 설계 프로젝트 초기 세팅 홈 화면, 뮤멘트 리스트 조회, 히스토리 조회	DB 스키마 설계 프로젝트 초기 세팅 보관함, 검색, 뮤멘트 기록

Server Architecture

API

▶️ API 명세서

Method	View	description	🎤담당	progress	issue
POST	로그인	로그인	🌊유정	✅ 완료	#24
GET	홈	배너 조회	🌊유정	✅ 완료	#49
GET		오늘의 뮤멘트 조회	🌊유정	✅ 완료	#47
GET		다시 들은 곡의 뮤멘트	🌊유정	✅ 완료	#51
GET		랜덤 태그, 랜덤 뮤멘트	🌊유정	✅ 완료	#30
GET		곡 검색	🎶채은	✅ 완료	#15
GET		곡 상세 페이지 - 곡, 나의 뮤멘트	🌊유정	✅ 완료	#7
GET		곡 상세 페이지 - 모든 뮤멘트 조회	🌊유정	✅ 완료	#12
GET	기록하기	처음/다시 들어요 선택	🎶채은	✅ 완료	#19
POST		뮤멘트 기록하기	🎶채은	✅ 완료	#4
PUT		뮤멘트 수정하기	🎶채은	✅ 완료	#27
GET		뮤멘트 상세보기	🎶채은	✅ 완료	#6
DELETE		뮤멘트 삭제하기	🎶채은	✅ 완료	#28
GET		나의 히스토리	🌊유정	✅ 완료	#13
GET	보관함	내가 작성한 뮤멘트 리스트	🎶채은	✅ 완료	#10
GET		좋아요한 뮤멘트 리스트	🎶채은	✅ 완료	#14
POST	좋아요	뮤멘트 좋아요 등록	🌊유정	✅ 완료	#21
DELETE		뮤멘트 좋아요 취소	🌊유정	✅ 완료	#21

Collection

▶️ db 콜렉션 스키마

Foldering

📦src
┣ 📂config
┣ 📂controllers
┣ 📂interfaces
┃  ┣ 📂common
┃  ┣ 📂like
┃  ┣ 📂mument
┃  ┣ 📂music
┃  ┣ 📂user
┣ 📂loaders
┣ 📂models
┣ 📂modules
┣ 📂routes
┣ 📂services
┣ 📜index.ts

Dependency

"devDependencies": {
        "@types/express": "^4.17.13",
        "@types/mongoose": "^5.11.97",
        "@types/node": "^17.0.25",
        "@typescript-eslint/eslint-plugin": "^5.30.5",
        "@typescript-eslint/parser": "^5.30.5",
        "eslint": "^8.19.0",
        "eslint-config-prettier": "^8.5.0",
        "eslint-plugin-prettier": "^4.2.1",
        "nodemon": "^2.0.15",
        "prettier": "^2.7.1",
        "ts-node": "^10.7.0",
        "typescript": "^4.6.3"
},
"dependencies": {
        "axios": "^0.27.2",
        "dayjs": "^1.11.3",
        "dotenv": "^16.0.0",
        "express": "^4.17.3",
        "express-validator": "^6.14.0",
        "husky": "^8.0.1",
        "mongoose": "^6.3.1"
}

Commit Convention

태그	설명
[FEAT]	새기능 추가
[ADD]	부수적인 코드 추가, 라이브러리 추가, 새 파일 생성
[MOD]	로직 변경, 코드 영향을 주는 수정
[DEL]	코드 삭제
[FIX]	버그 수정
[CHORE]	코드에 영향을 주지 않는 수정
[REFACTOR]	코드 리팩토링
[TEST]	테스트 코드 작성, 수정
[DOCS]	문서 업데이트

Branch Strategy

브랜치	설명
main	배포용 브랜치
dev	릴리즈 전 개발용 브랜치
dev_rdb	릴리즈 용 개발 브랜치
dev_chaen	채은 develop 브랜치
dev_youju	유정 develop 브랜치

Git Workflow

1) issue 등록
2) 로컬 dev_본인 브랜치에서 각자 기능 별 개발
3) 작업 완료 시 issue number와 함께 commit, push
2) dev 브랜치에 PR
3) 코드리뷰 후 merge

Coding Convention

coding convention

- 인터페이스명: 🐫UpperCammelCase
- 파일명: 🐫UpperCammelCase
- 변수명: 🐪lowerCammelCase
    - 명사 + 명사
    - 복수 쓰지 않기
    List나 개수를 나타내는 단어로 쓸 것
    - 배열 생성 시
    foos:Foo[] 이런식으로 작성
    
- 함수명: 🐪lowerCammelCase
    - 동사 + 명사
    
- DB 파일명: 🐪lowerCammelCase

- 상수: 대문자

- 따옴표: ‘’(작은 따옴표- 백틱은 예외)

- 축약 가능한 단어
    - num
    - req
    - res
    - 그 외 단어 축약하지 않기
    
- 세미콜론 꼭 달기

- 중괄호
    // 나쁜 예
    wrongExample()
    {
    	const isServerWeak = true;
    }
    
    // 좋은 예
    goodExample() {
    	const isServerBest = true;
    };
        
- 주석
    // 한줄 주석
    
    /**
    * 여러줄
    * 주석
    */
    
    컨트롤러 주석
    /**
    * @ROUTE
    * @DESC
    */