README.md

Dooribon Server

작은 움직임이 만드는 우리다운 여행 두리번

두리번 의 핵심 기능은 다음과 같습니다.

그룹성향파악, 위시리스트, 여행보드, 일정관리

두리번을 통해 함께 여행하는 사람들의 성향을 파악하고, 즐거운 여행을 만들어 가세요.

SOPT 28th APPJAM

프로젝트 기간: 2021.06.26 ~ 2021.07.17

📋 IA

💡 API 명세서

API 명세서 최종

🛠 Development Environment

🛠 Server Architecture

📋 Model Diagram

⚙️ Dependencies Module

"devDependencies": {
    "@types/express": "^4.17.11",
    "@types/mongoose": "^5.10.5",
    "@types/node": "^15.6.0",
    "nodemon": "^2.0.7",
    "ts-node": "^9.1.1",
    "typescript": "^4.2.4"
  },
  "dependencies": {
    "axios": "^0.21.1",
    "bcryptjs": "^2.4.3",
    "dotenv": "^9.0.2",
    "express": "^4.17.1",
    "express-validator": "^6.12.0",
    "jsonwebtoken": "^8.5.1",
    "mongoose": "^5.13.2",
    "nanoid": "^3.1.23",
    "qs": "^6.10.1"
  }

📌 Branch Strategy

Git Workflow

 1. local - feature에서 각자 기능 작업
 2. 작업 완료 후 local - develop (ex. xxeol) 에 PR 후 Merge
 3. 이후 remote - develop 으로 PR
 4. 코드 리뷰 후 Confirm 받고 Merge
 5. remote - develop 에 Merge 될 때 마다 모든 팀원 remote - develop pull 받아 최신 상태 유지

Branch Name	설명
main	초기 세팅 존재
develop	로컬 develop merge 브랜치
jobchae	정아 로컬 develop 브랜치
xxeol	설희 로컬 develop 브랜치
judy	주현 로컬 develop 브랜치
localdevelop_feature/#issue	각자 기능 추가 브랜치

📌 Commit Convention

태그: 제목의 형태

태그 이름	설명
feat	새로운 기능을 추가할 경우
fix	버그를 고친 경우
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우
style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
comment	필요한 주석 추가 및 변경
docs	문서를 수정한 경우 (ex. README 수정)
rename	파일 혹은 폴더명을 수정하거나 옮기는 작업인 경우
remove	파일을 삭제하는 작업만 수행한 경우
chore	빌드 태스크 업데이트, 패키지 매니저를 설정하는 경우

📌 Coding Convention

변수명

1. Camel Case 사용

• lower Camel Case

2. 함수의 경우 동사+명사 사용

• ex) getInformation()

3. 길이는 20자로 제한한다.

• 부득이한 경우 팀원과의 상의를 거친다.

4. flag로 사용 되는 변수는 조동사 + flag 종류로 구성

• ex) isNum

5. 약어는 되도록 사용하지 않는다.

주석

1. 한줄 주석은 // 를 사용한다.
2. 그 이상은 /** */ 를 사용한다.
3. 함수 설명 주석은 2번을 사용한다.

Bracket

// 한줄 if 문 - 여러 줄로 작성
 if(trigger) {
   return;
 }

// 괄호 사용 한칸 띄우고 사용한다.
 if (left == true) {
    return;
 }

// 띄어쓰기
 if (a == 5) { // 양쪽 사이로 띄어쓰기
    return;  
 }

비동기 함수의 사용

1. async, await 함수 사용을 지향한다.
2. Promise 사용은 지양한다.

DataBase

1. Model 파일명은 대문자
2. 필드명은 CamelCase 사용

🙋🏻‍♀️ 담당

DB 설계

기능명	담당자	완료 여부
User Model 설계	변주현	완료
Group Model 설계	변주현	완료
Schedule Model 설계	정설희	완료
Wish Model 설계	채정아	완료
Board Model 설계	채정아	완료

api 구현

기능명	담당자	완료 여부
카카오 로그인	채정아	완료
여행 생성	채정아	완료
여행 그룹 멤버 추가	채정아	완료
그룹 성향 테스트 결과 조회	채정아	완료
성향 테스트 질문 조회	채정아	완료
여행 일정 삭제	채정아	완료
여행 별 이미지 조회	채정아	완료
여행 정보 조회	채정아	완료
성향 테스트 결과 저장	채정아	완료
성향 테스트 카운팅 조회	채정아	완료
ec2 배포, s3 관리	채정아	완료
일자 별 여행 일정 조회	정설희	완료
특정 여행 일정 조회	정설희	완료
일자 별 여행 일정 조회	정설희	완료
여행 일정 추가	정설희	완료
여행 일정 수정	정설희	완료
여행 보드 추가	정설희	완료
여행 이미지 전체 조회	변주현	완료
참여코드로 여행 참여, 정보 조회	변주현	완료
마이페이지 조회	변주현	완료
여행 수정	변주현	완료
여행 보드 조회	변주현	완료
여행 보드 수정	변주현	완료
여행 보드 삭제	변주현	완료
사용자 기간 별 여행 조회	변주현	완료

👩🏻‍💻 Developers

채정아	정설희	변주현
jokj624	xxeol2	wngus4296