diff --git a/README.md b/README.md index 75e8a294..4b0aa3e0 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,25 @@ -# 야구장 좌석 시야 확인 서비스, SPOT +
-> 디프만 15기 6팀의 서버 repository +NotFound -
+
+ +

⚾️ 내가 만드는 야구장 시야 확인 서비스, SPOT! 🏟️

-[![서버 팀 문서](http://img.shields.io/badge/-서버_팀_문서-81B441?style=flat&logo=Pinboard&logoColor=white)](https://github.com/depromeet/SPOT-server/wiki) +
+ +[![PlayStore](http://img.shields.io/badge/PlayStore-34A853?style=flat&logo=android&logoColor=white&link=https://play.google.com/store/apps/details?id=com.dpm.spot)](https://play.google.com/store/apps/details?id=com.dpm.spot) +[![Instagram](http://img.shields.io/badge/Instagram-E4405F?style=flat&logo=instagram&logoColor=white&link=https://www.instagram.com/spot_baseballview/)](https://www.instagram.com/spot_baseballview/) +[![WIKI](http://img.shields.io/badge/WiKi-181717?style=flat&logo=GitHub&logoColor=white&link=https://github.com/depromeet/SPOT-server/wiki)](https://github.com/depromeet/SPOT-server/wiki) +
+[![서비스 소개](http://img.shields.io/badge/서비스_소개-1976D2?style=flat&logo=notion&logoColor=white&link=https://bit.ly/3YxsqXe)](https://bit.ly/3YxsqXe) +[![서버파트 개발 로그](http://img.shields.io/badge/서버_개발_로그-7F52FF?style=flat&logo=Lemmy&logoColor=white&link=)]() +[![메이커 로그](http://img.shields.io/badge/메이커_로그-81B441?style=flat&logo=Pinboard&logoColor=white&link=https://dis.qa/fbtJ9H)](https://dis.qa/fbtJ9H)
+
+ ## 🧑‍💻 팀원 소개
@@ -17,4 +29,83 @@ | _ | _ | _ | | BE | BE, 파트장 | BE | -
\ No newline at end of file +
+ +
+ +## 🛠️ 백엔드 사용 기술 + +
+ + + +
+ +
+ +## ⚙️ 인프라 & DevOps 사용 기술 + +
+ + + +
+ +
+ +## 📁️ 프로젝트 설계 + +### 🧩 설계 원칙 + +1. `직관적` : 동료 개발자가 별도의 설명서가 없어도 프로그램을 이해하고 활용할 수 있어야 한다. +2. `유연성` : 기존 기능의 변경, 또는 신규 기능의 추가가 용이해야 한다. +3. `효율성` : 유저가 최소한의 latency로 서비스를 경험할 수 있어야 한다. + +
+ +### ✨️ 패키지 - 멀티 모듈 아키텍처 + +
+ + + +| 모듈명 | 역할 | +| --- |--------------------------------------------------------------------------------------------------------------------| +| common | 각 모듈에서 공통으로 사용해야 하는 코드들을 모아둔 모듈입니다. (ex. exception) | +| application | 프로그램 가동에 필요한 app들을 모아둔 모듈입니다. 현재는 user 서비스만 존재하지만, 추후 batch, admin 등 다양한 app이 추가될 수 있습니다. | +| domain | SPOT! 서비스 구현에 필요한 도메인 객체들을 모아둔 모듈입니다. POJO로 구성됩니다. | +| usecase | SPOT! 서비스 구현에 필요한 비즈니스 요구사항들을 구현한 모듈입니다. port(interface)와 구현체를 분리해 DIP를 프로젝트 단위로 구현했습니다. | +| infrastructure | 외부 의존성을 갖는 코드들을 모아둔 모듈입니다. (ex. jpa, aws, redis..) usecase는 persistence, redis 구현체가 아닌 추상화에 의존하므로 외부 의존성 교체가 쉽습니다. | + +
+ +
+ +### 🖥️ 시스템 아키텍처 + +
+ + + +
+ +
+ +## 🤔 기술적 의사결정 + +- SPOT! 서버 팀의 무한 스크롤링 구현방법 [>> Link](https://github.com/depromeet/SPOT-server/wiki/%EB%AC%B4%ED%95%9C-%EC%8A%A4%ED%81%AC%EB%A1%A4%EB%A7%81%EA%B3%BC-%ED%8E%98%EC%9D%B4%EC%A7%80%EB%84%A4%EC%9D%B4%EC%85%98) + +
+ +## 📚 트러블슈팅 + +- Nginx http 301 redirection 설정 버그 픽스 [Issue #118](https://github.com/depromeet/SPOT-server/issues/118) +- M1 ARM Mac에서 Embedded Redis 실행 오류 버그 픽스 [Issue #173](https://github.com/depromeet/SPOT-server/issues/173) + +
+ +## 📬 SPOT! 관련 문의는 아래 연락처로 부탁드려요! + +- 문의사항 | [6jihaeng@gmail.com](mailto:6jihaeng@gmail.com) +- 인스타그램 | [@spot_baseballview](https://www.instagram.com/spot_baseballview/) +- 서비스 피드백하기 | https://forms.gle/NG2JSsSivTQkNVRE9 diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 00000000..ad6b30d1 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,3 @@ +dockerHubRepository=spot-server +dockerHubUsername=6jihaeng +dockerHubPassword=dbrwlgod15! \ No newline at end of file diff --git a/images/BE_use_skill.jpeg b/images/BE_use_skill.jpeg new file mode 100644 index 00000000..1d8e4360 Binary files /dev/null and b/images/BE_use_skill.jpeg differ diff --git a/images/Thumbnail.png b/images/Thumbnail.png new file mode 100644 index 00000000..ed6d7c65 Binary files /dev/null and b/images/Thumbnail.png differ diff --git a/images/infra_use_skill.jpeg b/images/infra_use_skill.jpeg new file mode 100644 index 00000000..9b609760 Binary files /dev/null and b/images/infra_use_skill.jpeg differ diff --git a/images/package.png b/images/package.png new file mode 100644 index 00000000..3fcff959 Binary files /dev/null and b/images/package.png differ diff --git "a/images/\354\213\234\354\212\244\355\205\234\354\225\204\355\202\244\355\205\215\354\262\230.jpeg" "b/images/\354\213\234\354\212\244\355\205\234\354\225\204\355\202\244\355\205\215\354\262\230.jpeg" new file mode 100644 index 00000000..db470eba Binary files /dev/null and "b/images/\354\213\234\354\212\244\355\205\234\354\225\204\355\202\244\355\205\215\354\262\230.jpeg" differ