README.md

Runnect-Spring-Boot-Server

점과 점으로, 코스와 코스로 연결되는 너와 나의 러닝 경험

---

☝ 서비스 핵심 기능

1. 코스 그리기

코스 그리기로 달리기 전 목표를 설정하고 실시간 트래킹으로 코스르 따라 잘 달리고 있는지 확인합니다.

2. 코스 발견

코스 발견을 통해 나에게 맞는 코스를 추천 받거나 다른 유저가 공유한 코스를 검색하고 스크랩합니다. 코스를 직접 업로드할 수 도 있습니다.

3. 코스 보관함

코스 보관함에서 내가 그린 코스와 스크랩 코스를 관리합니다.

4. 마이페이지

마이페이지에서 프로필과 활동 기록, 업로드한 코스를 확인하고 목표 보상으로 동기를 강화합니다.

---

🧑‍🔧 Tech Stack

Backend

DB

CI/CD

Deploy

Develop Tool

Communicate Tool

---

🏠 server architecture

---

💽 DB ERD

---

📄 API(+ Non - API) Docs

---

🙆‍♀️ 역할분담

담당자	담당 내용
유수화	EC2, publicCourse & stamp 관련 api, 인프라 구축
전선희	RDS, course & user 관련 api, 인프라 구축
박수린	S3, record & scrap 관련 api, 인프라 구축

---

🗣️️ 컨벤션

💡 동료들과 말투를 통일하기 위해 컨벤션을 지정합니다. 오합지졸의 코드가 아닌, 한 사람이 짠 것같은 코드를 작성하는 것이 추후 유지보수나 협업에서 도움이 됩니다. 내가 코드를 생각하면서 짤 수 있도록 해주는 룰이라고 생각해도 좋습니다!

👩‍💻 Coding Conventions

명명규칙(Naming Conventions)

1. 이름으로부터 의도가 읽혀질 수 있게 쓴다.

2. 단수를 기본형으로 한다.

   • 기능 자체에서 단수, 복수를 구분하는 경우에만 복수 사용 ex. 다중삭제, 단일삭제

3. DB의 테이블, 클래스에는 PascalCase를 사용한다.

4. 변수, 메소드에는 camelCase를 사용한다.

5. DB의 테이블의 칼럼에는 snake_case를 사용한다.

6. 상수, enum에는 UPPER_SNAKE_CASE를 사용한다.

7. 메소드는 crud + http method(동사) + 명사 형태로 작성한다.

   • c : ex. createUser
   • r : ex. getUser
   • u : ex. updateUser
   • d : ex. deleteUser

8. 약어 사용은 최대한 지양한다.

9. 이름에 네 단어 이상이 들어가면 팀원과 상의를 거친 후 사용한다.

주석(Comment)

1. 해당 메소드가 어디에 쓰이는지 설명한다.

2. 해당 분기문이 어떤 분기인지 설명한다.

3. 반복문에서 어떤 조건에서 반복되는지 설명한다.

4. 정렬하고 필터링할때 어떤 조건의 정렬과 필터링인지 설명한다.

---

🌳 Branch

🌱 git branch 전략

main branch : 운영 서버 배포 단위 branch

dev branch : 주요 개발 branch, main merge 전 거치는 branch, test 서버로 배포되는 branch

feat branch: 각자 개발 branch

• 할 일 issue 등록 후 issue 번호와 isuue 이름으로 branch 생성 후 작업
  • ex) feat/#issue num-isuue name(기능요약)
• 해당 branch 작업 완료 후 PR 보내기
  • 항상 local에서 충돌 해결 후 → remote에 올리기
  • reviewer에 서로 tag후 code-review
  • comment 전 merge 불가!
  • review반영 후, 본인이 merge.

branch 구조

- main
- dev
- feat
   ├── #1-isuue name1
   └── #2-isuue name2

---

🧵 Commit Convention

📍 git commit message convention

ex) feat(변경한 파일) : 변경 내용 (/#issue num)

- ✨ feat:      새로운 기능 구현
- 🐛 fix:       버그, 오류 해결
- 🧹 chore:     src 또는 test 파일을 수정하지 않는 기타 변경 사항 ( 새로운 파일 생성, 파일 이동, 이름 변경 등 )
- ♻️ refactor:  버그 수정이나 기능 추가가 없는 코드 변경 ( 코드 구조 변경 등의 리팩토링 )
- 💎 style:     코드의 의미에 영향을 미치지 않는 변경 사항 ( 코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음 )
- 🏗️ build:    빌드 시스템 또는 외부에 영향을 미치는 변경 사항 종속성 ( 라이브러리 추가 등 )
- 📈 perf:      성능을 향상 시키기 위한 코드 변경
- 🧪 test:      테스트 추가 또는 이전 테스트 수정
- 📝 docs:      README나 WIKI 등의 문서 개정
- ⏪️ revert:    이전 커밋을 되돌리는 경우
- 📦 ci:      CI 구성 파일 및 스크립트 변경
- Merge: 다른브렌치를 merge하는 경우
- Init : Initial commit을 하는 경우