Skip to content

Commit

Permalink
docs: readme 초안 작성
Browse files Browse the repository at this point in the history
  • Loading branch information
EunjiShin committed Sep 5, 2024
1 parent eeca5ac commit 0f7a275
Show file tree
Hide file tree
Showing 7 changed files with 114 additions and 5 deletions.
116 changes: 111 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,126 @@
# 야구장 좌석 시야 확인 서비스, SPOT
<div align=center>

> 디프만 15기 6팀의 서버 repository
<img src="./images/Thumbnail.png" alt="NotFound">

<div align=center>
<br/>

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

<br/>

[![서버 팀 문서](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)
<br>
[![서비스 소개](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)

</div>

<br/>

## 🧑‍💻 팀원 소개

---

<div align=center>

| 신은지 | 정준원 | 박민성 |
| :------------: |:-----------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------:|
| <a href="https://github.com/EunjiShin"> <img src="https://avatars.githubusercontent.com/EunjiShin" width=100px alt="_"/> </a> | <a href="https://github.com/wjdwnsdnjs13"> <img src="https://avatars.githubusercontent.com/u/67488973?v=4" width=100px alt="_"/> </a> | <a href="https://github.com/pminsung12"> <img src="https://avatars.githubusercontent.com/u/52368015?v=4" width=100px alt="_"/> </a> |
| BE | BE, 파트장 | BE |

</div>
</div>

<br/>

## 🛠️ 백엔드 사용 기술

---

<div align=center>

<img src="./images/BE_use_skill.jpeg">

</div>

<br/>

## ⚙️ 인프라 & DevOps 사용 기술

---

<div align=center>

<img src="./images/infra_use_skill.jpeg">

</div>

<br/>

## 📁️ 프로젝트 설계

---

### 🧩 설계 원칙

1. `직관적` : 동료 개발자가 별도의 설명서가 없어도 프로그램을 이해하고 활용할 수 있어야 한다.
2. `유연성` : 기존 기능의 변경, 또는 신규 기능의 추가가 용이해야 한다.
3. `효율성` : 유저가 최소한의 latency로 서비스를 경험할 수 있어야 한다.

<br/>

### ✨️ 패키지 - 멀티 모듈 아키텍처

<div align=center>

<img src="./images/package.png">

| 모듈명 | 역할 |
| --- |--------------------------------------------------------------------------------------------------------------------|
| 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 구현체가 아닌 추상화에 의존하므로 외부 의존성 교체가 쉽습니다. |

</div>

<br/>

### 🖥️ 시스템 아키텍처

---

<div align=center>

<img src="./images/시스템아키텍처.jpeg">

</div>

<br/>

## 🤔 기술적 의사결정

---

- github wiki에 작성하고 링크 걸어주세용

<br/>

## 📚 트러블슈팅

---

- 개인 블로그 등 링크 걸어주세용

<br/>

## 📬 SPOT! 관련 문의는 아래 연락처로 부탁드려요!

---

- 문의사항 | [[email protected]](mailto:[email protected])
- 인스타그램 | [@spot_baseballview](https://www.instagram.com/spot_baseballview/)
- 서비스 피드백하기 | https://forms.gle/NG2JSsSivTQkNVRE9
3 changes: 3 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dockerHubRepository=spot-server
dockerHubUsername=6jihaeng
dockerHubPassword=dbrwlgod15!
Binary file added images/BE_use_skill.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/infra_use_skill.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/시스템아키텍처.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0f7a275

Please sign in to comment.