🍭 Project

• 바쁜 현대인들을 위해 나만의 보상을 선사하는 보상 아카이빙 서비스

  쉽게 저장하고! 내가 원하는 대로 모으고! 보상을 골라 기다리는 설렘까지!

  잊었던 나를 위한 시간을 핸디캔디로 쌓아가세요.

  보상, 보상날 저장-원할 때 열람 가능-보상을 통한 만족감

• SOPT 28th APPJAM, HANDY-CANDY

• 프로젝트 기간: 2021.06.26~2021.07.17

내 손 안의 달콤한 보상, HANDY-CANDY

✨ Base URL

https://handycandy.cf

🗃 Server Architecture

🛠 개발 환경

📧API 명세서

API 명세서 링크

👀 ERD Diagram

📜 Coding Convention

📂 폴더구조

• src
  • Logger
  • api
  • config
  • interfaces
  • middleware
  • models
  • jobs
  • services
  • controllers
• Dockerfile
• eslint
• prettierrc
• commitlint
• tsconfig

🖋 네이밍

Class & Constructor

• 클래스/생성자 이름은 UpperCamelCase를 사용합니다.
• 글자의 길이는 20자 이내로 제한합니다.

좋은 예 >

  class HandyCandy

나쁜 예 >

  class handycandy {}

함수 & 변수 & 인스턴스

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

🏷 주석

• // MARK: 를 사용해서 연관된 코드를 구분짓습니다.
• /** */ 를 사용해서 코드 작성자의 이름을 명시합니다.

📎 기타

• , 뒤에 반드시 띄어쓰기를 합니다.
• 함수끼리 1줄 개행합니다.
• 중괄호는 아래와 같은 형식으로 사용합니다.

if (condition) {
  Statements;
  /*
  ...
  */
}

✉️ Commit Messge Rules

서버캔디 들의 Git Commit Message Rules

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

📜 커밋 메시지 명령어 모음

커밋 규칙을 지키지 않으면 commitlint에서 자동으로 에러가 발생합니다.

- feat    : 기능 (새로운 기능)
- fix     : 버그 (버그 수정)
- refactor: 리팩토링
- style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
- docs    : 문서 (문서 추가, 수정, 삭제)
- test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
- chore   : 기타 변경사항 (빌드 스크립트 수정 등)

ℹ️ 커밋 메세지 형식

• 커밋메세지: 설명 형식으로 커밋 메시지를 작성합니다.
• 커밋 설명은 무조건 영어로 한다고 좋은게 아닙니다.
• 최대한 내용 포함과 자세할수록 좋습니다.
• 하지만 너무 길게는 안됩니다.

좋은 예 >

  feat: search api 추가

나쁜 예 >

  검색 api 추가

좋은 예 >

  test: 회원가입 로직 test code 작성

나쁜 예 >

  test code 작성,
  test: test code 작성

💻 Github mangement

서버캔디 들의 WorkFlow : Gitflow Workflow

• Main과 Develop 브랜치

  메인(main): 메인 브랜치 -> product

  개발(development): 기능들의 통합 브랜치 역할❗️ 이 브랜치에서 기능별로 브랜치를 따 모든 구현이 이루어집니다. -> alpha

• Main에 직접적인 commit, push는 가급적 금지합니다. (X)

• 커밋 메세지는 다른 사람들이 봐도 이해할 수 있게 써주세요.

• 풀리퀘스트를 통해 코드 리뷰를 해보아요.

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

merge는 github에서 진행합니다.
merge pull request 금지 -> squash and merge 클릭
rebase 또는 conflict 해결은 github에서 하지 않습니다.

local code에서 git status로 확인해가며 적용 후 force push 진행합니다.
force push 정말 조심해주세요.

이슈 연동 방법

• 이슈 생성

  Github의 issue 탭에 들어가서 기능 정의서를 기반으로 issue를 생성합니다.
  commit message rules와 동일하게 이슈를 생성해주세요.
  이슈를 생성하면 자동으로 번호가 발급됩니다. 이 번호를 사용하여 feature 브랜치를 생성합니다.
  

• 브랜치를 생성하여 해당 브랜치에 commit, push 합니다.

• PR을 날릴 때 작성자와 리뷰어를 설정합니다.

• 이 때 resolved #이슈번호로 작성하면 merge될 때 해당 issue는 자동 삭제됩니다.

• 이렇게 PR이 생성되면 새로운 issue번호가 부여됩니다. 즉, PR도 issue입니다.

각자 자신이 맡은 기능 구현에 성공시! 브랜치 다 쓰고 병합하는 방법

• 브랜치 만듦

git branch feature/issue-번호

• 브랜치 전환

git checkout feature/issue-번호

• 브랜치 만듦과 동시에 전환

git checkout -b feature/issue-번호

• 코드 변경 (현재 feature/issue-번호 브랜치)

git add .
git commit -m "커밋 메세지" -a // 이슈보드 이름대로 커밋

- git add . 를 기능별로 모아둔게 아니라면 자주 쓰지 말아주세요.

- 해당 기능끼리 묶어서 커밋해주세요.

• 푸시 (현재 feature/issue-번호 브랜치)

git push origin feature/issue-번호 브랜치

• feature/기능 이슈 번호 브랜치에서 할 일 다 헀으면 pr에서 머지 후 development 브랜치로 전환

git checkout development

• 다 쓴 브랜치 삭제 (local) (현재 development 브랜치)

git branch -d feature/issue-번호

• 다 쓴 브랜치 삭제 (remote) (현재 development 브랜치)

git push origin :feature/issue-번호

• development pull (현재 development 브랜치)

git pull origin development

• 최신 development 커밋 반영 rebase

git rebase development
git status
-> conflict 있으면 해결

해결한 파일마다 git add services/UserService 와 같은 방식으로 add
git rebase --continue (다 반영했으면 다음 conflict로 넘어감)

🏹 Dependencies module

{
  "name": "handycandy",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "dev": "ts-node src",
    "start": "tsc && node dist",
    "build": "tsc && node dist",
    "test": "echo \"Error: no test specified\" && exit 1",
    "postinstall": "husky install"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@commitlint/cli": "^12.1.4",
    "@commitlint/config-conventional": "^12.1.4",
    "@types/cors": "^2.8.12",
    "@types/node": "^15.12.5",
    "@typescript-eslint/eslint-plugin": "^4.28.1",
    "@typescript-eslint/parser": "^4.28.1",
    "eslint": "^7.29.0",
    "eslint-config-airbnb-base": "^14.2.1",
    "eslint-config-prettier": "^8.3.0",
    "eslint-plugin-import": "^2.23.4",
    "eslint-plugin-prettier": "^3.4.0",
    "husky": "^7.0.0",
    "lint-staged": "^11.0.0",
    "prettier": "2.3.2",
    "ts-node": "^10.0.0",
    "typescript": "^4.3.4"
  },
  "dependencies": {
    "bcryptjs": "^2.4.3",
    "cookie-parser": "^1.4.5",
    "cors": "^2.8.5",
    "dotenv": "^10.0.0",
    "express": "^4.17.1",
    "express-validator": "^6.12.0",
    "gravatar": "^1.8.1",
    "jsonwebtoken": "^8.5.1",
    "moment": "^2.29.1",
    "moment-timezone": "^0.5.33",
    "mongoose": "^5.12.15",
    "nodemailer": "^6.6.2",
    "nodemailer-smtp-transport": "^2.7.4"
  },
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ]
  },
  "lint-staged": {
    "**/*.{js,ts}": "eslint"
  }
}