Skip to content

Commit

Permalink
Merge pull request #113 from kakao-tech-campus-2nd-step3/peeerr-patch-1
Browse files Browse the repository at this point in the history
docs: λ¦¬λ“œλ―Έ 정리
  • Loading branch information
peeerr authored Nov 14, 2024
2 parents efcec90 + c225da9 commit 39d12b1
Showing 1 changed file with 153 additions and 2 deletions.
155 changes: 153 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,153 @@
# Team21_BE
21μ‘° λ°±μ—”λ“œ
# Every Moment
> ν•˜λ£¨λ₯Ό μžλ™μœΌλ‘œ κΈ°λ‘ν•˜κ³  κ³΅μœ ν•˜λŠ” μœ„μΉ˜ 기반 μ†Œμ…œ 닀이어리 πŸ“
![image](https://github.com/user-attachments/assets/d2be179d-e5e4-4b14-914f-8d88f5e6f7b5)

<br/>

## πŸ“Œ ν”„λ‘œμ νŠΈ μ†Œκ°œ
맀 μˆœκ°„μ„ κΈ°λ‘ν•˜κ³  μ‹Άμ§€λ§Œ, λ°”μœ 일상 μ†μ—μ„œ 일기 μ“°κΈ°λŠ” 쉽지 μ•ŠμŠ΅λ‹ˆλ‹€.
Every MomentλŠ” μ‚¬μš©μžμ˜ μœ„μΉ˜ 데이터λ₯Ό 기반으둜 μ‚¬μš©μžμ˜ ν•˜λ£¨λ₯Ό **μžλ™**으둜 일기λ₯Ό κΈ°λ‘ν•˜κ³ , μΉœκ΅¬λ“€κ³Ό κ³΅μœ ν•  수 μžˆλŠ” μ†Œμ…œ 닀이어리 μ„œλΉ„μŠ€μž…λ‹ˆλ‹€.

## πŸ“Œ ν”„λ‘œμ νŠΈ μ†Œκ°œ
λ°”μœ 일상 μ†μ—μ„œ 맀 μˆœκ°„μ„ κΈ°λ‘ν•˜κΈ°λž€ 쉽지 μ•ŠμŠ΅λ‹ˆλ‹€.
Every MomentλŠ” μœ„μΉ˜ 데이터λ₯Ό 기반으둜 μ‚¬μš©μžμ˜ ν•˜λ£¨λ₯Ό **μžλ™**으둜 κΈ°λ‘ν•˜κ³  μΉœκ΅¬λ“€κ³Ό κ³΅μœ ν•  수 μžˆλŠ” μ†Œμ…œ 닀이어리 μ„œλΉ„μŠ€μž…λ‹ˆλ‹€.

### 핡심 κΈ°λŠ₯
- πŸ“ **μœ„μΉ˜ 기반 μžλ™ 기둝**: 15λΆ„ 이상 λ¨Έλ¬Έ μž₯μ†Œ μžλ™ 감지 및 일기둜 기둝

- 🀝 **μ†Œμ…œ 닀이어리**: μΉœκ΅¬λ“€κ³Ό 일기 곡유 및 μ†Œν†΅
- πŸ” **슀마트 검색**: λ‹€μ–‘ν•œ 필터링 μ˜΅μ…˜μœΌλ‘œ μ›ν•˜λŠ” 일기 λΉ λ₯Έ 검색
- πŸ”” **μ‹€μ‹œκ°„ μ•Œλ¦Ό**: μΉœκ΅¬μ™€μ˜ μƒν˜Έμž‘μš©(μ’‹μ•„μš”, λŒ“κΈ€, 친ꡬ μš”μ²­ λ“±)κ³Ό μƒˆλ‘œμš΄ μž₯μ†Œ 감지λ₯Ό μ‹€μ‹œκ°„μœΌλ‘œ μ•Œλ¦Ό

<br/>

## ⭐️ μ£Όμš” κΈ°λŠ₯
| μžλ™ 일기 기둝 | μ†μ‰¬μš΄ 일기 νŽΈμ§‘ | λ‹€μ–‘ν•œ 검색 필터링 | μΉœκ΅¬μ™€μ˜ 일기 곡유 |
|:---:|:---:|:---:|:---:|
| <img src="https://github.com/user-attachments/assets/c7aa92f4-0ab9-44bb-8abf-872eaeeefcbb" width="200px"> | <img src="https://github.com/user-attachments/assets/a3557c70-d183-4929-ab36-5833bacf2e36" width="200px"> | <img src="https://github.com/user-attachments/assets/3448752f-2c20-4d72-b59f-560708a6e037" width="200px"> | <img src="https://github.com/user-attachments/assets/fb29d6e7-8325-4656-8514-e6767bc034fc" width="200px"> |
| 15λΆ„λ™μ•ˆ λ¨Έλ¬Έ μž₯μ†Œλ₯Ό<br>μžλ™μœΌλ‘œ 기둝 | μ €μž₯된 일기λ₯Ό<br>μ†μ‰½κ²Œ νŽΈμ§‘ | λ‹€μ–‘ν•œ 검색 쑰건으둜<br>μ†μ‰¬μš΄ 일기 μ°ΎκΈ° | μ›ν•˜λŠ” 일기λ₯Ό κ³΅μœ ν•˜μ—¬<br>μΉœκ΅¬μ™€ μ†Œν†΅ |

<br/>

## πŸ” ν”„λ‘œμ νŠΈ 정보
### 개발 κΈ°κ°„
- 2024.09 ~ 2024.11 (3κ°œμ›”)

### μ„œλΉ„μŠ€ 링크
- **API μ„œλ²„**: http://13.125.156.74:8080

- **API λ¬Έμ„œ**: [Swagger UI](http://13.125.156.74:8080/swagger-ui/index.html) | [λ…Έμ…˜ λ¬Έμ„œ](https://peeerr.notion.site/API-2e575ca8df07493dbc25f3d0e91ca211?pvs=4)

### ν”„λ‘œμ νŠΈ 관리
- **[Backend Repository](https://github.com/kakao-tech-campus-2nd-step3/Team21_BE)**
- **[Android Repository](https://github.com/kakao-tech-campus-2nd-step3/Team21_Android)**

- **[Git Flow μ „λž΅](https://github.com/kakao-tech-campus-2nd-step3/Team21_BE/wiki/Git-Flow-%EC%A0%84%EB%9E%B5)**
- **[μ½”λ”© μ»¨λ²€μ…˜](https://github.com/kakao-tech-campus-2nd-step3/Team21_BE/wiki/%EC%BD%94%EB%94%A9-%EC%BB%A8%EB%B2%A4%EC%85%98)**
- **[컀밋 μ»¨λ²€μ…˜](https://github.com/kakao-tech-campus-2nd-step3/Team21_BE/wiki/%EC%BB%A4%EB%B0%8B-%EC%BB%A8%EB%B2%A4%EC%85%98)**

<br/>

## πŸ‘₯ νŒ€μ› μ†Œκ°œ
저희 νŒ€μ€ **λ°±μ—”λ“œ 2λͺ…, μ•ˆλ“œλ‘œμ΄λ“œ 3λͺ…**으둜 κ΅¬μ„±λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€.

<table align="center">
<tr align="center">
<td><B>μ΅œμ€€ν˜•<B></td>
<td><B>μ „ν˜œμ§€<B></td>
<td><B>이아림<B></td>
<td><B>μœ€μ±„μ›<B></td>
<td><B>κΆŒμƒˆμΌ<B></td>
</tr>
<tr align="center">
<td>
<a href="https://github.com/peeerr">
<img src="https://github.com/peeerr.png" style="max-width: 100px">
</a>
<br>
<a href="https://github.com/peeerr"><B>Backend</B></a>
</td>
<td>
<a href="https://github.com/HyeJiJUN11">
<img src="https://github.com/HyeJiJUN11.png" style="max-width: 100px">
</a>
<br>
<a href="https://github.com/HyeJiJUN11"><B>Backend</B></a>
</td>
<td>
<a href="https://github.com/arieum">
<img src="https://github.com/arieum.png" style="max-width: 100px">
</a>
<br>
<a href="https://github.com/arieum"><B>Android</B></a>
</td>
<td>
<a href="https://github.com/settle54">
<img src="https://github.com/settle54.png" style="max-width: 100px">
</a>
<br>
<a href="https://github.com/settle54"><B>Android</B></a>
</td>
<td>
<a href="https://github.com/todlf">
<img src="https://github.com/todlf.png" style="max-width: 100px">
</a>
<br>
<a href="https://github.com/todlf"><B>Android</B></a>
</td>
</tr>
</table>

<br/>

## πŸ›  기술 μŠ€νƒ
### πŸ’» Language & Framework
- Java 21
- Spring Boot 3.3
- Spring Security
- Spring Data JPA

### πŸ“Š Database & Storage
- MySQL
- AWS S3 (파일 μ €μž₯μ†Œ)

### πŸ“± Communication
- Firebase Cloud Messaging (FCM)

### πŸ— Infra
- AWS EC2
- AWS RDS

### πŸ”§ Development Tools
- GitHub Actions

### πŸ“š Documentation & Testing
- Swagger
- JUnit5

### βš™οΈ Others
- JWT (인증/인가)
- Lombok

<br/>

## πŸ—„οΈ ERD
![erd](https://github.com/user-attachments/assets/72e66248-f217-434a-9f20-d8150abafee4)

<br/>

## πŸ” 개발 μ£Όμ•ˆμ 
- **μ‹€μ‹œκ°„μ„± 확보**
- FCM을 ν™œμš©ν•œ 즉각적인 ν‘Έμ‹œ μ•Œλ¦Ό κ΅¬ν˜„

- λŒ“κΈ€, μ’‹μ•„μš”, 친ꡬ μš”μ²­, μžλ™ 일기 μž‘μ„± λ“± λ‹€μ–‘ν•œ μ΄λ²€νŠΈμ— λŒ€ν•œ μ‹€μ‹œκ°„ μ•Œλ¦Ό

- **CI/CD νŒŒμ΄ν”„λΌμΈ ꡬ좕 및 μ΅œμ ν™”**
- Github Actionsλ₯Ό ν™œμš©ν•œ 배포 μžλ™ν™”

- PR λ‹¨κ³„μ—μ„œ μžλ™ν™”λœ ν…ŒμŠ€νŠΈ μ‹€ν–‰μœΌλ‘œ 개발 생산성 ν–₯상
- μ΄μ „μ—λŠ” 배포 ν™˜κ²½μ—μ„œ ν…ŒμŠ€νŠΈ μ‹€νŒ¨ μ‹œ μƒˆλ‘œμš΄ PR을 μƒμ„±ν•˜κ³ , λ°°ν¬ν•˜λŠ” 과정을 λ°˜λ³΅ν•΄μ•Ό ν–ˆμŒ

- **ν…ŒμŠ€νŠΈ μž‘μ„±**
- 70% μ΄μƒμ˜ ν…ŒμŠ€νŠΈ 컀버리지 μœ μ§€

0 comments on commit 39d12b1

Please sign in to comment.