Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hyh1016 authored Sep 17, 2024
1 parent e8c281e commit 22b2979
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# ๐Ÿ• ๋ฉ๋ฉ์ด ์‚ฐ์ฑ… ๊ธฐ๋ก ๋ฐ ๊ณต์œ  ์„œ๋น„์Šค
# ๐Ÿ• ๊ฐ•์•„์ง€ ์‚ฐ์ฑ… ๊ธฐ๋ก ๋ฐ ๊ณต์œ  ์„œ๋น„์Šค, 'pawpaw'

Nexters 25๊ธฐ ๋ฉ๋ฉ์ด ์‚ฐ์ฑ… ๊ธฐ๋ก ๋ฐ ๊ณต์œ  ์„œ๋น„์Šค์˜ ๋ฐฑ์—”๋“œ ์ €์žฅ์†Œ์ž…๋‹ˆ๋‹ค.
![image](https://github.com/user-attachments/assets/f6a7f76b-3172-4ae8-9357-25638ce1bcbf)

## ๊ฐœ๋ฐœ์ž
```
pawpaw๋Š” ๊ฐ•์•„์ง€์˜ ์‚ฐ์ฑ…์„ ๊ธฐ๋กํ•˜๊ณ , ์นœ๊ตฌ๋“ค๊ณผ ์‚ฐ์ฑ… ๊ธฐ๋ก์„ ๊ณต์œ ํ•˜๋ฉฐ ์†Œํ†ตํ•  ์ˆ˜ ์žˆ๋Š” ๊ธฐ๋กํ˜• SNS ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค.
```
## Download Link
- pawpaw๋Š” ์•„์ง ์•ฑ์Šคํ† ์–ด ์‹ฌ์‚ฌ์ค‘์ž…๋‹ˆ๋‹ค!

## ๊ฐœ๋ฐœ์ž (BE)
- ์กฐ๋ฏผ๊ตญ ( minkukjo )
- ํ•˜์ดํ˜„ ( hyh1016 )

## ์ž‘์—… ๊ทธ๋ผ์šด๋“œ ๋ฃฐ
- GitHub Flow๋ฅผ ๋”ฐ๋ฅธ๋‹ค.
- ๋ชจ๋“  ์ฝ”๋“œ๋Š” ์ƒํ˜ธ ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋ฅผ ํ•˜๋Š” ๊ฒƒ์„ ์›์น™์œผ๋กœ ํ•˜๋ฉฐ ๋ฆฌ๋ทฐ ๋ฐ›๊ธฐ ์ „๊นŒ์ง€ main ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ•˜์ง€ ์•Š๋Š”๋‹ค.
- ํ…Œ์ŠคํŠธ๋ฅผ ์—ด์‹ฌํžˆ ์ง ๋‹ค.
- ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๋ฅผ ์—ด์‹ฌํžˆ ์ง ๋‹ค.

## How to run
1. `docker-compose up`์„ ํ†ตํ•ด mysql ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰
1. `docker-compose up`์„ ํ†ตํ•ด compose ์„ค์ • ํŒŒ์ผ์— ๋ช…์‹œ๋œ mysql ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰
2. spring boot application ์‹คํ–‰

## Create API Docs
1. gradle > documentation > openapi3 (๋˜๋Š” ./gradlew :api:openapi3)
2. ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ์‹คํ–‰ ํ›„ /docs/swagger ๊ฒฝ๋กœ์—์„œ API ๋ฌธ์„œ ํ™•์ธ ๊ฐ€๋Šฅ
## ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜
![image](https://github.com/user-attachments/assets/9bd5a6f6-145d-4082-991d-f12ae8ae1e9e)

0 comments on commit 22b2979

Please sign in to comment.