diff --git a/README.md b/README.md index 8739fb6e..77a68d49 100644 --- a/README.md +++ b/README.md @@ -1 +1,77 @@ # hankki-server + +# ๐Ÿ‘‹ ABOUT HANKKI +<๋กœ๊ณ ๋“ค์–ด๊ฐˆ์˜ˆ์ •>
+**`WHAT ?`** ๋Œ€ํ•™๊ต๋ฅผ ์ค‘์‹ฌ์œผ๋กœ **8000์› ์ดํ•˜์˜ ๋ฉ”๋‰ด๋ฅผ ๊ฐ€์ง„ ์‹๋‹น**์„ ์ œ๊ณตํ•˜๋Š” ํ”„๋กœ๋•ํŠธ + +**`HOW?`** ์„œ์šธ ๋‚ด์˜ ๋Œ€ํ•™ ๋ฌถ์Œ 9-10๊ฐœ๋ฅผ ์ค‘์‹ฌ์œผ๋กœ 50๊ฐœ์”ฉ ์•ฝ 500๊ฐœ์˜ ์‹๋‹น์„ ๋ชจ์•„ ๋ฆด๋ฆฌ์ฆˆํ•˜๊ณ , ์ถ”ํ›„ **์œ ์ €์ฐธ์—ฌํ˜•**์œผ๋กœ ์šด์˜ํ•  ๊ณ„ํš + +**`WHY?`** ์น˜์†Ÿ๋Š” ๋ฌผ๊ฐ€์— ๋ฐฅ ํ•œ๋ผ ๋จน๊ธฐ๋„ ๋ถ€๋‹ด๋˜๋Š” ์š”์ฆ˜, ์ €๋ ดํ•œ ์‹๋‹น์„ ๊ณต์œ ํ•˜๋ฉฐ **ํ•จ๊ป˜** **์ž˜ ๋จน๊ณ  ์ž˜ ์‚ด๊ธฐ ์œ„ํ•ด์„œ!** + +# โš’๏ธStack + +
+ +
+ +# ๐Ÿ“ERD +![hankki](https://github.com/Team-Hankki/hankki-server/assets/109809242/36c645b6-68e6-42b8-a9e2-9ddf790a6f4f) + +# ๐Ÿ“œ Covention +## Code Convetion +| ํ•ญ๋ชฉ | ๊ทœ์น™ | +|---------------------|---------------------------------------------------------------------------------------| +| `Class` | **PascalCase** | +| `Function` | **camelCase** | +| `Variable` | **camelCase** | +| `DB Table` | **snake_case** | +| `ENUM`, `Contatant` | **PascalCase** | +| `Collection` | ๋ฆฌ์ŠคํŠธ๋Š” ๋ณต์ˆ˜ํ˜•, ๋‹ค๋ฅธ ์ปฌ๋ ‰์…˜์€ ์ ‘๋ฏธ์‚ฌ๋กœ ์ปฌ๋ ‰์…˜. (Ex. **users**, userMap) | +| `LocalDateTime` | ์ ‘๋ฏธ์‚ฌ์— **Date ํ˜น์€ At**. | + +## โ™ฃ๏ธGit Convention +### prefix +| type | what | +|--------------|-----------------------| +| `feat` | ๊ตฌํ˜„ | +| `fix` | ์ˆ˜์ • | +| `refac` | ๋ฆฌํŒฉํ† ๋ง | +| `chore` | ํŒจํ‚ค์ง€ ๊ตฌ์กฐ ์ˆ˜์ • | +| `docs` | ๋ฌธ์„œ ์ˆ˜์ • | +| `infra` | ์ธํ”„๋ผ ๊ด€๋ จ ์ž‘์—… | +| `hotfix` | ์šด์˜ ์„œ๋ฒ„ ํ•ซํ”ฝ์Šค ์ž‘์—… | +|'dependency' | ์˜์กด์„ฑ(์•„๋งˆ ์˜์กด์„ฑ๋งŒ ์ถ”๊ฐ€ํ•˜๋Š” ์ž‘์—…์„ ์—†์„ ๊ฒƒ์œผ๋กœ ์˜ˆ์ƒ๋˜์–ด ์“ธ ์ผ์€ ์—†์„๋“ฏ)| + +### Branch Naming +`/` + +### Commit Message +`[] ` + +### Pull Request +title : `[] ` +```Markdown +## Related Issue ๐Ÿ“Œ +close # + +## Description โœ”๏ธ +- + +## To Reviewers +``` +### Review +| PN| what| +|------|-----| +|P1 | ๊ผญ ๋ฐ˜์˜ํ•ด์ฃผ์„ธ์š” (Request changes) | +|P2 | ์ ๊ทน์ ์œผ๋กœ ๊ณ ๋ คํ•ด์ฃผ์„ธ์š” (Request changes) | +| P3| ์›ฌ๋งŒํ•˜๋ฉด ๋ฐ˜์˜ํ•ด ์ฃผ์„ธ์š” (Comment) | +| P4 | ๋ฐ˜์˜ํ•ด๋„ ์ข‹๊ณ  ๋„˜์–ด๊ฐ€๋„ ์ข‹์Šต๋‹ˆ๋‹ค (Approve) | +|P5 | ๊ทธ๋ƒฅ ์‚ฌ์†Œํ•œ ์˜๊ฒฌ์ž…๋‹ˆ๋‹ค (Approve) | + +# ๐Ÿคผโ€โ™€๏ธTeam Member + +| [๋ฐ•์žฌ์—ฐ๐Ÿ‘‘](https://github.com/Parkjyun) | [๊น€๊ฐ€์—ฐ๐ŸŒฑ](https://github.com/kgy1008) | [๋ฐ•์„œ์ง„๐ŸŒฑ](https://github.com/PicturePark1101)| +|--------|------- |---------- | +| | | | +| โœ”๏ธServer ๋ฆฌ๋“œ
โœ”๏ธDB ์„ค๊ณ„
โœ”๏ธํ™ˆํ™”๋ฉด API | โœ”๏ธ์†Œ์…œ๋กœ๊ทธ์ธ(KAKAO, APPLE)
โœ”๏ธ์‹๋‹น API| โœ”๏ธ๋งˆ์ดํŽ˜์ด์ง€ API
โœ”๏ธ์กฑ๋ณด API | +