Skip to content
/ FOODY Public

๐Ÿฅฆ ์ทจํ–ฅ, ์‹๋‹จ, ๋ณด์œ  ์‹์žฌ๋ฃŒ ๋“ฑ์„ ๊ณ ๋ คํ•œ ๋ ˆ์‹œํ”ผ ์ถ”์ฒœ ์„œ๋น„์Šค ๐Ÿฅฆ

Notifications You must be signed in to change notification settings

jjoyra/FOODY

Folders and files

NameName
Last commit message
Last commit date

Latest commit

989bbb7 ยท Oct 26, 2023
Sep 12, 2023
Oct 4, 2023
Oct 5, 2023
Oct 6, 2023
Oct 5, 2023
Oct 5, 2023
Sep 10, 2023
Oct 26, 2023

Repository files navigation

๐Ÿฅฆ FOODY ๐Ÿฅฆ

2023.08.28 ~ 2023.10.06(6์ฃผ)

๐ŸŽ ์„œ๋น„์Šค ์†Œ๊ฐœ ๐ŸŽ

FOODY_main

๊ฑด๊ฐ•ํ•œ ํ•œ ๋ผ์˜ ์‹œ์ž‘, FOODY

๊ฐœ์ธ ์‹ ์ฒด ์ •๋ณด์— ์ ์ ˆํ•œ ๊ถŒ์žฅ ์˜์–‘์†Œ์™€ ์ทจํ–ฅ, ๋ณด์œ ํ•˜๊ณ  ์žˆ๋Š” ์‹์žฌ๋ฃŒ ๋“ฑ์„ ๊ณ ๋ คํ•˜์—ฌ
์‹๋‹จ ๋ฐ ๋ ˆ์‹œํ”ผ๋ฅผ ์ถ”์ฒœํ•ด์ฃผ๋Š” ๋ ˆ์‹œํ”ผ ์ถ”์ฒœ ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค.

๐ŸŽ ํ•ต์‹ฌ ๊ธฐ๋Šฅ ๐ŸŽ

  1. ์‹์‚ฌ ์‚ฌ์ง„์œผ๋กœ ์Œ์‹์„ ์ธ์‹ํ•˜๊ณ  ์˜์–‘์†Œ๋ฅผ ๋ถ„์„ํ•ฉ๋‹ˆ๋‹ค.
  2. ์‹ ์ฒด ์ •๋ณด๋ฅผ ๊ธฐ์ค€์œผ๋กœ ์ผ์ผ ๊ถŒ์žฅ ์˜์–‘์†Œ๋ฅผ ๊ณ„์‚ฐํ•˜์—ฌ ํ˜„์žฌ ๋ถ€์กฑํ•œ ์˜์–‘์†Œ๋ฅผ ์•Œ๋ ค์ค๋‹ˆ๋‹ค.
  3. ์„ธ๊ฐ€์ง€ ๋ฐฉ์‹์œผ๋กœ ๋งž์ถคํ™” ๋ ˆ์‹œํ”ผ๋ฅผ ์ถ”์ฒœํ•ฉ๋‹ˆ๋‹ค.
    1. ์‚ฌ์šฉ์ž ์ทจํ–ฅ๊ณผ ๋ถ€์กฑ ์˜์–‘์†Œ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ์‹์‚ฌ๋ฅผ ์ถ”์ฒœํ•ฉ๋‹ˆ๋‹ค.
    2. ๋ณด์œ ํ•˜๊ณ  ์žˆ๋Š” ์žฌ๋ฃŒ์™€ ๋ถ€์กฑ ์˜์–‘์†Œ์— ๊ธฐ๋ฐ˜์œผ๋กœ ์ถ”์ฒœํ•ฉ๋‹ˆ๋‹ค.
    3. ์œ ์‚ฌํ•œ ์‚ฌ์šฉ์ž์˜ ์‹์‚ฌ์™€ ์‚ฌ์šฉ์ž์˜ ์„ ํ˜ธ๋„๋ฅผ ์ข…ํ•ฉํ•˜์—ฌ ์ถ”์ฒœํ•ฉ๋‹ˆ๋‹ค.
  4. ์˜์ˆ˜์ฆ ์ธ์‹์œผ๋กœ ๊ฐ„ํŽธํ•˜๊ฒŒ ์‹์žฌ๋ฃŒ๋ฅผ ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ๊ณ , ๋ณด์œ  ์‹์žฌ๋ฃŒ๋ฅผ ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐ŸŽ ์ฃผ์š” ๊ธฐ์ˆ  ๐ŸŽ

  1. OCR ๊ธฐ์ˆ ์„ ํ™œ์šฉํ•œ ์˜์ˆ˜์ฆ ์ธ์‹
  2. ์ด๋ฏธ์ง€ ๋ถ„๋ฅ˜ ๋ชจ๋ธ YOLO์„ ์ถ”๊ฐ€ํ•™์Šตํ•˜์—ฌ ์Œ์‹ ์‚ฌ์ง„ ์ธ์‹ ๋ฐ ๋ถ„์„์— ํ™œ์šฉ
  3. 10๋งŒ๊ฐœ ์ด์ƒ์˜ ๋น„์ •ํ˜• ์Œ์‹๋ฐ์ดํ„ฐ ๊ฐ€๊ณต
  4. ์‚ฌ์šฉ์ž์˜ ์ทจํ–ฅ์— ๊ธฐ๋ฐ˜ํ•œ ๋ ˆ์‹œํ”ผ ์ถ”์ฒœ ๋ฐ์ถ”์ฒœ ๋กœ์ง ์ตœ์ ํ™”
  5. ๋น„์ •ํ˜• ๋ฐ์ดํ„ฐ์˜ ์ „์ฒ˜๋ฆฌ๋ฅผ ํ•˜๋Š” Flask์„œ๋ฒ„, FastAPI ์„œ๋ฒ„๋ฅผ ์ด์šฉํ•˜์—ฌ YOLO์™€ ๋น…๋ฐ์ดํ„ฐ ์ถ”์ฒœ ์‹œ์Šคํ…œ์„ ๋ถ„๋ฆฌ
  6. Redis๋ฅผ ํ™œ์šฉํ•œ ๊ฒ€์ƒ‰์–ด ์ž๋™์™„์„ฑ ๊ธฐ๋Šฅ ์ตœ์ ํ™”

๐ŸŽ ์ฃผ์š” ํ™”๋ฉด ๐ŸŽ

๋ฉ”์ธํŽ˜์ด์ง€ ํƒญ๋ฐ” + ๋ฒ„ํŠผ
์‹๋‹จํŽ˜์ด์ง€ ์‹๋‹จ ๋“ฑ๋ก
๋ƒ‰์žฅ๊ณ  ํŽ˜์ด์ง€ ์žฌ๋ฃŒ ๋“ฑ๋ก
๋ ˆ์‹œํ”ผ ์ถ”์ฒœ ํŽ˜์ด์ง€ ๋ ˆ์‹œํ”ผ ์ƒ์„ธ๋ณด๊ธฐ
๋งˆ์ดํŽ˜์ด์ง€ ๋ถ๋งˆํฌ

> ํ™”๋ฉด GIF ๋ณด๋Ÿฌ๊ฐ€๊ธฐ <

๐Ÿ… ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ณ ๐Ÿ…

๐Ÿ… ERD ๐Ÿ…

Foody_ERD

๐Ÿ… ์ถ”๊ฐ€ ์‚ฐ์ถœ๋ฌผ ๐Ÿ…

๐Ÿฅ‘ Commit Convention ๐Ÿฅ‘

// ์ž‘์—… ์ข…๋ฅ˜
init: ํ”„๋กœ์ ํŠธ ์…‹ํŒ…
feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ํ•  ๊ฒฝ์šฐ
fix: ๋ฒ„๊ทธ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ
docs: ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ(ex. Swagger, README)
style: ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ
refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
chore: ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •(ex. dependency ์ถ”๊ฐ€)
merge: ์ถฉ๋Œ ์‹œ mergeํ•  ๊ฒฝ์šฐ

// ์˜ˆ์‹œ
feat: ๋กœ๊ทธ์ธ API ๊ตฌํ˜„

๐Ÿฅ‘ Git Flow ๐Ÿฅ‘

# Branch๋ช…
master : ์šด์˜ ์„œ๋ฒ„๋กœ ๋ฐฐํฌํ•˜๊ธฐ ์œ„ํ•œ branch
develop : ์•ˆ์ •๋˜๊ณ  ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ branch
FE/develop : frontend develop
BE/develop : backend develop
{ํฌ์ง€์…˜}/feat/{๊ธฐ๋Šฅ}#{์ด์Šˆ ๋ฒˆํ˜ธ} : ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์„ ์œ„ํ•œ branch
{ํฌ์ง€์…˜}/refactor/{๊ธฐ๋Šฅ}#{์ด์Šˆ ๋ฒˆํ˜ธ} : ๋ฆฌํŒฉํ† ๋ง branch
{ํฌ์ง€์…˜}/hotfix : dev ๋ธŒ๋žœ์น˜์—์„œ ๋ฐœ์ƒํ•œ ๋ฒ„๊ทธ๋ฅผ ์ˆ˜์ •ํ•˜๋Š” branch

// ์˜ˆ์‹œ
BE/feat/user#1

# Pull Request๋ช…
๋ธŒ๋žœ์น˜๋ช…
# Pull Request ๋‚ด์šฉ
ํ…œํ”Œ๋ฆฟ

๐Ÿฅ‘ Jira Convention ๐Ÿฅ‘

- ๋‹ด๋‹น์ž, ์Šคํ† ๋ฆฌ ํฌ์ธํŠธ ์ง€์ • ํ•„์ˆ˜
- ํŒ€์›๋ผ๋ฆฌ ์Šคํ† ๋ฆฌ ํฌ์ธํŠธ ๋ฐธ๋Ÿฐ์Šค ๋งž์ถ”๊ธฐ
- ์Šคํ† ๋ฆฌ ํฌ์ธํŠธ ํ•˜๋‚˜ ๋‹น 4 ๋„˜์ง€ ์•Š๋„๋ก ํ• ๋‹น

๐Ÿฅ• ํŒ€์› ์†Œ๊ฐœ ๐Ÿฅ•

์‹ ํ˜ธ์ธ ์‹ ์ƒ์› ์ด๊ทœ๋ฏผ
BE, ํŒ€์žฅ BE BE
์กฐํฌ๋ผ ๊น€์Šนํ˜„ ์ž„ํฌ์„ 
BE FE FE

๐Ÿฅ•์‚ฌ์šฉ ๊ธฐ์ˆ ๐Ÿฅ•

FrontEnd

  • TypeScript : 4.9.5
  • React : 18.2.0
  • Recoil
  • Axios
  • styled-component
  • ESLint
  • Prettier

BackEnd

  • JAVA : 17
  • Spring : 2.7.15
    • Spring Data JPA
    • Spring Security
    • Spring Rest Docs
  • Python
  • FastAPI
  • MySQL
  • Redis

CI/CD

  • AWS EC2
  • Jenkins
  • Docker : 24.0.6, build ed223bc
  • Amazon S3
  • NginX : nginx/1.18.0 (Ubuntu)

Tool

  • Git
  • Jira
  • Notion
  • Mattermost
  • Figma
  • VS Code
  • intellij

About

๐Ÿฅฆ ์ทจํ–ฅ, ์‹๋‹จ, ๋ณด์œ  ์‹์žฌ๋ฃŒ ๋“ฑ์„ ๊ณ ๋ คํ•œ ๋ ˆ์‹œํ”ผ ์ถ”์ฒœ ์„œ๋น„์Šค ๐Ÿฅฆ

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published