💙 Project

솝트인을 위한 가장 간편한 자기소개, '나를 다' 담은 명함 서비스, "나다 NADA"

Core Value : Simple / Easy / Compact

SOPT 28th Hackathon

프로젝트 기간: 2021.05.22 ~ 2021.05.23 Release : Comming Soon..!

💡서비스 IA

🛠 개발 환경 (Development Environment)

• Development Environment
  

📄 API 문서 (API DOC LINK)

NADA Server API 문서📜

📄 Dependency Module

서버왕을꿈꾸는 🐰토끼들의🐰 프로젝트 의존성 모듈 설정

"dependencies": {
    "@types/express": "^4.17.11",
    "aws-sdk": "^2.911.0",
    "bcryptjs": "^2.4.3",
    "dotenv": "^9.0.2",
    "express": "^4.17.1",
    "express-validator": "^6.11.1",
    "gravatar": "^1.8.1",
    "jsonwebtoken": "^8.5.1",
    "mongoose": "^5.12.10",
    "multer": "^1.4.2",
    "multer-s3": "^2.9.0",
    "nodemon": "^2.0.7",
    "request": "^2.88.2"
  }

• Async & Await
• request(HTTP)
• Node.js - Chrome V8 자바스크립트 엔진으로 빌드된 자바스크립트 런타임
• Express.js - Node.js 웹 애플리케이션 프레임워크
• NPM - 자바 스크립트 패키지 관리자
• vscode - 편집기
• MongoDB - DataBase
• AWS EC2 - 클라우드 환경 컴퓨팅 시스템

💃 Models

✉️ Commit Messge Rules

서버왕을꿈꾸는 🐰토끼들의🐰 Git Commit Message Rules

---

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

📜 커밋 메시지 명령어 모음

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

ℹ️ 커밋 메세지 형식

• [커밋메세지] 설명 형식으로 커밋 메시지를 작성합니다.
• 커밋 메시지는 영어 사용을 권장합니다.

좋은 예 >

  [Feat] complete MatchingAPI feat

나쁜 예 >

  매칭 API 구현 성공

💻 Github mangement

서버왕을꿈꾸는 🐰토끼들의🐰 WorkFlow : Gitflow Workflow

---

• main 브랜치

메인(main): 메인 브랜치

이름: 이름별 로컬 브랜치

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

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

- Main
   ├── jieun
   └── yaewon

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

• 브랜치 만듦

git branch 기능(or 이름 브랜치)

• 원격 저장소에 로컬 브랜치 push

git push --set-upstream origin 브랜치이름(이름 브랜치)

git push -u origin 브랜치이름(이름 브랜치)

• 브랜치 전환

git checkout 이름 브랜치

• 코드 변경 (현재 뷰이름 브랜치)

git add .
git commit -m "커밋 메세지" origin 이름 브랜치

• 푸시 (현재 이름 브랜치)

git push origin 이름 브랜치 

• 이름 브랜치에서 할 일 다 했으면 main 브랜치로 전환

git checkout main

• 머지 (현재 main 브랜치)

git merge 이름 브랜치

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

git branch -d 이름 브랜치

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

git push origin :이름 브랜치

• main pull (현재 main 브랜치)

git pull or git pull origin main

• main push (현재 main 브랜치)

git push or git push origin main

👯‍♀️ 기능별 개발여부 + 담당자

NADA Server 개발 일지 📜

기능	개발 여부	담당자
api/register		오예원
api/loadInfo		오예원
api/matching		황지은

NADA Server Dev

황지은	오예원
hwangji-dev	yaeoni