Skip to content

3NFJ/deliver-foodie-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

234 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

deliver-foodie

๐Ÿœ ๋ฐฐ๋‹ฌ ๋ฐ ํฌ์žฅ ์Œ์‹ ์ฃผ๋ฌธ ๊ด€๋ฆฌ ํ”Œ๋žซํผ ํ”„๋กœ์ ํŠธ

ํ”„๋กœ์ ํŠธ ๊ฐœ์š”

์Œ์‹ ๋ฐฐ๋‹ฌ ํ”Œ๋žซํผ "Deliver Foodie"
์‚ฌ์žฅ๋‹˜๊ณผ ๊ณ ๊ฐ์„ ์—ฐ๊ฒฐํ•˜๋Š” ๋ฐฐ๋‹ฌ ์„œ๋น„์Šค ํ”Œ๋žซํผ์œผ๋กœ, ํŽธ๋ฆฌํ•œ ์ฃผ๋ฌธ๊ณผ ํšจ์œจ์ ์ธ ๊ฐ€๊ฒŒ ๊ด€๋ฆฌ๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
๊ฐœ๋ฐœ ๊ธฐ๊ฐ„: 2024.11.06 ~ 2024.11.18 (2์ฃผ)

๐Ÿ‘ฅ ํŒ€์› ์†Œ๊ฐœ ๋ฐ ์—ญํ•  ๋ถ„๋‹ด

์ด๋ฆ„ ํฌ์ง€์…˜ ๋‹ด๋‹น ๊ธฐ๋Šฅ GitHub
์†์˜ˆ์ง€ Team Leader โ€ข ํšŒ์› ์ธ์ฆ/์ธ๊ฐ€ ์‹œ์Šคํ…œ ๊ตฌํ˜„
โ€ข ํšŒ์› /๊ถŒํ•œ ๊ด€๋ฆฌ
โ€ข API ๋ฌธ์„œํ™”
โ€ข ํ”„๋กœ์ ํŠธ ์ผ์ • ๊ด€๋ฆฌ ๋ฐ ์กฐ์œจ
@github
์‹ ์˜ํ•œ Sub Leader โ€ข ์ฃผ๋ฌธ ์‹œ์Šคํ…œ ๊ตฌํ˜„
โ€ข ๋ฆฌ๋ทฐ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
โ€ข ERD ์„ค๊ณ„ ๋ฐ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ชจ๋ธ๋ง
@github
์†๋™ํ•„ Infra Leader โ€ข ๊ฐ€๊ฒŒ/๋ฉ”๋‰ด ๊ด€๋ฆฌ ์‹œ์Šคํ…œ ๊ตฌํ˜„
โ€ข Gemini AI ์ฑ—๋ด‡ ์„œ๋น„์Šค ์—ฐ๋™
โ€ข AWS ์ธํ”„๋ผ ์„ค๊ณ„ ๋ฐ ๊ตฌ์ถ•
@github

์ธํ”„๋ผ ์„ค๊ณ„๋„

Infra

์„œ๋น„์Šค ๊ตฌ์„ฑ ๋ฐ ์‹คํ–‰๋ฐฉ๋ฒ•

ํ•„์ˆ˜ ์š”๊ตฌ์‚ฌํ•ญ

  • Java 17
  • PostgreSQL 15
  • AWS ๊ณ„์ • (S3 ์‚ฌ์šฉ)
  • Gemini API Key

1. ํ”„๋กœ์ ํŠธ ํด๋ก 

git clone https://github.com/3NFJ/deliver-foodie-backend.git
cd deliver-foodie-backend
  1. ํ™˜๊ฒฝ๋ณ€์ˆ˜ ์„ค์ • application.yml ํŒŒ์ผ ์ƒ์„ฑ ๋ฐ ์„ค์ •
spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/your_database
    username: your_username
    password: your_password

  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

aws:
  s3:
    access-key: your_aws_access_key
    secret-key: your_aws_secret_key
    bucket: your_bucket_name
    region: ap-northeast-2

jwt:
  secret: your_jwt_secret_key

ai:
  url: your_url
  key: your_gemini_api_key
  1. Docker๋ฅผ ์‚ฌ์šฉํ•œ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์„ค์ •
docker run --name postgres-container \
  -e POSTGRES_DB=your_database \
  -e POSTGRES_USER=your_username \
  -e POSTGRES_PASSWORD=your_password \
  -p 5432:5432 \
  -d postgres:15
  1. ํ”„๋กœ์ ํŠธ ๋นŒ๋“œ
./gradlew clean build
  1. ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ์‹คํ–‰
./gradlew bootRun

์ฃผ์š” ๊ธฐ๋Šฅ

  1. ํšŒ์› ๊ด€๋ฆฌ
  • ํšŒ์›๊ฐ€์ž… ๊ธฐ๋Šฅ
    • ์‚ฌ์šฉ์ž๋Š” ํšŒ์›๊ฐ€์ž… ํ›„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ํšŒ์›๊ฐ€์ž…์‹œ ๋‹‰๋„ค์ž„, ์ด๋ฉ”์ผ์€ ์ค‘๋ณต๋  ์ˆ˜ ์—†๋‹ค.
  • ๋กœ๊ทธ์ธ, ๋กœ๊ทธ์•„์›ƒ ๊ธฐ๋Šฅ
    • ๋กœ๊ทธ์ธํ•œ ๊ฒฝ์šฐ์—๋งŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๋กœ๊ทธ์ธ์€ JWT ๊ธฐ๋ฐ˜์œผ๋กœ ์ œ๊ณตํ•œ๋‹ค.
  • ๋ชจ๋“  ๊ธฐ๋Šฅ์€ ์—ญํ•  ๊ธฐ๋ฐ˜์œผ๋กœ ๊ถŒํ•œ์ด ๋ถ€์—ฌ๋œ๋‹ค. (๊ณ ๊ฐ/์‚ฌ์žฅ๋‹˜/๊ด€๋ฆฌ์ž)
  1. ์Œ์‹์  ๊ด€๋ฆฌ

    • ๊ด€๋ฆฌ์ž ๊ถŒํ•œ์˜ ์‚ฌ์šฉ์ž๋งŒ ์Œ์‹์  ๋“ฑ๋กํ•˜๊ณ  ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๊ด€๋ฆฌ์ž๋Š” ์Œ์‹์  ์ •๋ณด๋ฅผ ๋“ฑ๋กํ•˜๊ณ , ์ˆ˜์ • ๋ฐ ์‚ญ์ œํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๋ชจ๋“  ์‚ฌ์šฉ์ž๋Š” ์Œ์‹์  ๋ชฉ๋ก์„ ์กฐํšŒํ•  ์ˆ˜ ์žˆ๋‹ค.
  2. ๋ฉ”๋‰ด ๊ด€๋ฆฌ

  • ์‚ฌ์žฅ๋‹˜ ๊ถŒํ•œ์˜ ์‚ฌ์šฉ์ž๋Š” ๊ฐ€๊ฒŒ์˜ ๋ฉ”๋‰ด๋ฅผ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ๋‹ค.
  • ๋ฉ”๋‰ด ์‚ญ์ œ ๋ฐ ๋ฉ”๋‰ด ์ˆจ๊ธฐ๊ธฐ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•œ๋‹ค.
  • ๋ชจ๋“  ์‚ฌ์šฉ์ž๋Š” ๊ฐ€๊ฒŒ๋ณ„ ๋ฉ”๋‰ด๋ฅผ ์กฐํšŒํ•  ์ˆ˜ ์žˆ๋‹ค.
  1. ์ฃผ๋ฌธ ๊ด€๋ฆฌ

    • ๊ณ ๊ฐ์€ ์›ํ•˜๋Š” ๊ฐ€๊ฒŒ์˜ ๋ฉ”๋‰ด๋ฅผ ๋‹ด์•„ ์ฃผ๋ฌธํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๊ณ ๊ฐ์€ ์‹ค์‹œ๊ฐ„ ์ฃผ๋ฌธ ์ƒํƒœ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ์ฃผ๋ฌธ ํ™•์ธ ์ค‘์ธ ์ฃผ๋ฌธ์€ ์ทจ์†Œํ•  ์ˆ˜ ์—†๋‹ค.
  2. ๋ฆฌ๋ทฐ ๊ด€๋ฆฌ

    • ๊ณ ๊ฐ ๊ถŒํ•œ์˜ ์‚ฌ์šฉ์ž๋Š” ๋ฆฌ๋ทฐ๋ฅผ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๋ฆฌ๋ทฐ ๋“ฑ๋ก/์ˆ˜์ • (์ด๋ฏธ์ง€ ์—…๋กœ๋“œ)
  3. AI ๊ธฐ๋ฐ˜ ์‚ฌ์žฅ๋‹˜ ๋ฉ”๋‰ด ์„ค๋ช… ๋“ฑ๋ก

    • ์‚ฌ์žฅ๋‹˜์€ Gemini AI๋ฅผ ํ™œ์šฉํ•ด ๋ฉ”๋‰ด ์„ค๋ช…์„ ์ œ๊ณต๋ฐ›์„ ์ˆ˜ ์žˆ๋‹ค.
    • ์ œ๊ณต ๋ฐ›์€ ๋ฉ”๋‰ด ์„ค๋ช…์€ ๋ชจ์•„๋ณด๊ธฐ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ๋ชฉ๋ก์œผ๋กœ ์ œ๊ณตํ•œ๋‹ค.
  4. ์นดํ…Œ๊ณ ๋ฆฌ ๊ธฐ๋Šฅ

    • ๊ด€๋ฆฌ์ž ๊ถŒํ•œ์˜ ์‚ฌ์šฉ์ž๋Š” ์นดํ…Œ๊ณ ๋ฆฌ๋ฅผ ๋“ฑ๋กํ•˜๊ณ  ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ๋‹ค.
  5. ๋ฐฐ์†ก์ง€ ๊ด€๋ฆฌ

    • ๊ณ ๊ฐ ์‚ฌ์šฉ์ž๋Š” ๋ฐฐ์†ก์ง€๋ฅผ ๋“ฑ๋กํ•˜๊ณ  ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๋ฐฐ์†ก์ง€๋Š” ์—ฌ๋Ÿฌ๊ฐœ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ๊ธฐ๋ณธ ๋ฐฐ์†ก์ง€๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ๋‹ค.

ERD

ERD

๊ธฐ์ˆ  ์Šคํƒ

Backend

Database

Infrastructure

Development Tools

API docs

๐Ÿ“Ž ์ „์ฒด API ๋ช…์„ธ์„œ ๋ณด๋Ÿฌ๊ฐ€๊ธฐ

ํ…Œ์ด๋ธ” ๋ช…์„ธ์„œ

๐Ÿ“Ž ํ…Œ์ด๋ธ” ๋ช…์„ธ์„œ ๋ณด๋Ÿฌ๊ฐ€๊ธฐ

์ง„ํ–‰ ์ผ์ • ๋ฐ ์ƒ์„ธ ์ •๋ณด ํ™•์ธํ•˜๊ธฐ

๐Ÿ“Ž 3NFJ ํŒ€ ์‹œํŠธ

About

๐Ÿœ ๋ฐฐ๋‹ฌ ๋ฐ ํฌ์žฅ ์Œ์‹ ์ฃผ๋ฌธ ๊ด€๋ฆฌ ํ”Œ๋žซํผ ํ”„๋กœ์ ํŠธ

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors