Skip to content

Team-Offroad/Offroad-server

Repository files navigation

image

💻 Offroad-Server


🍀 NOW-SOPT 34th, Team "Offroad"의 Server Repository입니다.

📖 Project Name & Description


🧭 Name : Offroad (오프로드)

🧭 Description : 일상에서 모험을 찾는 온오프라인 연계 게임 서비스입니다.

⌨️ Development Information


Environment

java spring hibernate aws mysql docker gradle

Tools

git github intellij

Social

slack discord notion

Stacks

redis sprint security swagger

🧙 Members & Roles


최윤한 김환준 김의진
image image image
❗️서버리드
❗서버 초기 세팅
❗Sentry 및 Test 세팅
❗ Discord Webhook 구축
❗Exception Handling
❗API 명세서 템플릿 작성
❗DB 초안 설계
❗S3 세팅
❗Docker기반 CI/CD 구축
❗️API 공통 response 작성
❗Swagger 세팅
❗구글/애플 소셜로그인 구현
❗API 명세서 템플릿 작성

🌊 Git Flow

image

📒 Convention


☕️ Code Convention

✅ 타입 : Pascal Case

✅ 변수 및 함수 : Camel Case

✅ 상수 : Snake Case

☕️ Commit Convention

type description
feat 기능개발
refactor 코드 개선
chore 기타 사소한 수정
fix 버그 수정 관련
setting 세팅 관련
test 테스트 관련
modify 코드 수정이 생길 경우
[type] : content

☕️ Pull Request Convention

✅ 제목 : [작업 키워드] 작업내용 (ex : [feat] Docker 기반 CI/CD구축)

✅ 리뷰 : Pn룰 활용 (P3 제외)

✅ 템플릿, Label, Test 스크린샷 이용

🌊 Deploy Flow

Frame 1

🔧 Structure


🌱 단일 모듈 프로젝트에서 멀티 모듈 프로젝트로 확장을 고려하여 구조를 생각했습니다.

📦offloadserver
 ┣ 📂api
 ┃ ┣ 📂characterEntity
 ┃ ┃ ┣ 📂controller
 ┃ ┃ ┣ 📂dto
 ┃ ┃ ┃ ┗ 📂response
 ┃ ┃ ┣ 📂service
 ┃ ┃ ┗ 📂usecase
 ┃ ┣ 📂charactermotion
 ┃ ┃ ┗ 📂service
 ┃ ┣ 📂config
 ┃ ┣ 📂emblem
 ┃ ┃ ┣ 📂controller
 ┃ ┃ ┣ 📂dto
 ┃ ┃ ┃ ┣ 📂request
 ┃ ┃ ┃ ┗ 📂response
 ┃ ┃ ┣ 📂service
 ┃ ┃ ┗ 📂usecase
 ┃ ┣ 📂exception
 ┃ ┣ 📂memberEntity
 ┃ ┃ ┣ 📂controller
 ┃ ┃ ┣ 📂dto
 ┃ ┃ ┃ ┣ 📂request
 ┃ ┃ ┃ ┗ 📂response
 ┃ ┃ ┣ 📂service
 ┃ ┃ ┗ 📂usecase
 ┃ ┣ 📂message
 ┃ ┣ 📂placeEntity
 ┃ ┃ ┣ 📂controller
 ┃ ┃ ┣ 📂dto
 ┃ ┃ ┃ ┣ 📂constans
 ┃ ┃ ┃ ┣ 📂request
 ┃ ┃ ┃ ┗ 📂response
 ┃ ┃ ┣ 📂service
 ┃ ┃ ┗ 📂usecase
 ┃ ┣ 📂questEntity
 ┃ ┃ ┣ 📂controller
 ┃ ┃ ┣ 📂dto
 ┃ ┃ ┃ ┗ 📂response
 ┃ ┃ ┣ 📂service
 ┃ ┃ ┗ 📂usecase
 ┃ ┣ 📂response
 ┃ ┣ 📜HealthCheckController.java
 ┃ ┗ 📜HealthCheckControllerSwagger.java
 ┣ 📂common
 ┃ ┣ 📂auth
 ┃ ┃ ┗ 📂filter
 ┃ ┣ 📂config
 ┃ ┗ 📂jwt
 ┣ 📂db
 ┃ ┣ 📂announcement
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┣ 📂characterEntity
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┣ 📂charactermotion
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┣ 📂coupon
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┣ 📂emblem
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┣ 📂memberEntity
 ┃ ┃ ┣ 📂embeddable
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┣ 📂placeEntity
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┃ ┗ 📂questEntity
 ┃ ┃ ┣ 📂embeddable
 ┃ ┃ ┣ 📂entity
 ┃ ┃ ┗ 📂repository
 ┣ 📂enums
 ┣ 📂external
 ┃ ┣ 📂aws
 ┃ ┣ 📂config
 ┃ ┣ 📂discord
 ┃ ┗ 📂oauth
 ┃ ┃ ┣ 📂apple
 ┃ ┃ ┗ 📂google
 ┃ ┃ ┃ ┣ 📂request
 ┃ ┃ ┃ ┗ 📂response
 ┗ 📜OffloadserverApplication.java

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages