README.md

🍴 Project

오늘 뭐 먹을래? 아무거나는 이제 그만! Let's COEAT! 모두가 행복한, 메뉴 취합 웹서비스

• SOPT 29th SOPTKATHON, COEAT
• 프로젝트 기간: 2021.11.20 ~ 2022.06

💙 Developers

주어진사랑	강한희
ozzing	kanghanhee

☕ 개발 담당 부분 & API 명세서

API 명세서 notion

📂 폴더구조

• src
  • api
  • config
  • constants
  • db
  • lib
  • middlewares

🧺 Dependencies

🧊 ERD & 테이블

🍹 코드 컨벤션

🖋 네이밍

함수 & 변수 & 인스턴스

• 함수와 변수, 인스턴스에는 camelCase를 사용합니다.

📝 주석

• // 를 단수행의 주석으로 사용합니다.
• /** ... */ 를 복수행의 주석으로 사용합니다.

🌿 기타

• 줄의 끝에 반드시 ,(콤마)를 붙입니다. 마지막 요소에도 ,를 붙이는 것에 유의합시다.
• 함수끼리 1줄 개행합니다.
• 중괄호는 아래와 같은 형식으로 사용합니다.

if (foo) {
  console.log(foo);
  /*
  ...
  */
}

🍙 Commit 전략

코잇서버 들의 Git Commit Message Rules

• 반영사항을 바로 확인할 수 있도록 작은 기능 하나라도 구현되면 커밋을 권장합니다.
• 기능 구현이 완벽하지 않을 땐, 각자 브랜치에 커밋을 해주세요.

💬 커밋 메시지 태그 모음

- feat    : 기능 (새로운 기능)
- update  : 코드 (코드 수정, 추가, 보완)
- fix     : 버그 수정
- docs    : 문서 (문서 추가, 수정, 삭제)
- chore   : 그 외 변경사항 (주석 추가,삭제 등)

🔸 커밋 타입

• 태그: 설명 형식으로 커밋 메시지를 작성합니다.
• 태그는 영어를 쓰고 첫 문자는 소문자로 작성합니다.

좋은 예 >

  feat: 검색 api 추가

나쁜 예 >

  검색 api 추가

🍕 Git Branch 전략

코잇서버 들의 WorkFlow : Gitflow Workflow

• 메인(main): 메인 브랜치
• 개발(develop): 기능들의 통합 브랜치
  • feature 브랜치

기능 개발시 → feat/issue번호 으로 브랜치를 파서 관리합니다.

develop에 바로 merge하지 않습니다.
pr을 develop로 해주세요.
develop에서 완성이 되면 main으로 그때 그때 merge합니다.

merge는 github에서 진행합니다.