Skip to content
MICGolfPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

ย 

History

236 Commits

Folders and files

Repository files navigation

Micgolf ์‡ผํ•‘๋ชฐ ์„œ๋น„์Šค - Backend


MIC golf ๋กœ๊ณ 

0. FastAPI ์‹คํ–‰ํ•˜๊ธฐ


  • FastAPI ๊ฐœ๋ฐœ ์„œ๋ฒ„ ์‹คํ–‰ ๋ช…๋ น์–ด

$ gunicorn -w 4 -k uvicorn.workers.UvicornWorker src.main:app

0-1. ๋žœ๋”ฉํŽ˜์ด์ง€

๋žœ๋”ฉํŽ˜์ด์ง€

0-2. ์นด์นด์˜ค ๋กœ๊ทธ์ธ

์นด์นด์˜ค ๋กœ๊ทธ์ธ

0-3. ์ƒํ’ˆ์กฐํšŒ, ์žฅ๋ฐ”๊ตฌ๋‹ˆ

์ƒํ’ˆ์กฐํšŒ์žฅ๋ฐ”๊ตฌ๋‹ˆ

0-4. ๊ฒฐ์ œ

๊ฒฐ์ œ

1. Project Overview (ํ”„๋กœ์ ํŠธ ๊ฐœ์š”)


  • ํ”„๋กœ์ ํŠธ ์ด๋ฆ„: Micgolf ์‡ผํ•‘๋ชฐ ์ œ์ž‘
  • ํ”„๋กœ์ ํŠธ ์„ค๋ช…: ๊ณจํ”„ ๋ธŒ๋žœ๋“œ '๋ฏน๊ณจํ”„(Micgolf)' ํ™ˆํŽ˜์ด์ง€ ์‹ ๊ทœ ๊ฐœ๋ฐœ


2. Team Members (ํŒ€์› ๋ฐ ํŒ€ ์†Œ๊ฐœ)


์•ˆ์šฐ์ง„ ๊ฐ•์Šน์ง„ ๊น€ํƒœ์šฐ ์ •๋ฏผ์ค€
์•ˆ์šฐ์ง„ ๊ฐ•์Šน์ง„ ๊น€ํƒœ์šฐ ์ •๋ฏผ์ค€
BE BE BE BE
GitHub GitHub GitHub GitHub

3. Key Features (์ฃผ์š” ๊ธฐ๋Šฅ)


  • ํšŒ์›๊ฐ€์ž…:

    • ์ž์ฒด ํšŒ์›๊ฐ€์ž… ๋ฐ ์†Œ์…œ(Naver, Kakao) ๋กœ๊ทธ์ธ ๊ตฌํ˜„
  • ์ƒํ’ˆ ๊ด€๋ฆฌ:

    • ์ƒํ’ˆ ๋“ฑ๋ก, ์ˆ˜์ •, ์‚ญ์ œ, ์กฐํšŒ ๋“ฑ
  • ํ”„๋กœ๋ชจ์…˜ ๊ด€๋ฆฌ:

    • "Best Choice", "Md's pick" ๋“ฑ ํ”„๋กœ๋ชจ์…˜ ๋“ฑ๋ก, ์กฐํšŒ, ์ˆ˜์ •, ์‚ญ์ œ ๊ธฐ๋Šฅ
  • ๋ฐฐ๋„ˆ, ์นดํ…Œ๊ณ ๋ฆฌ ๊ด€๋ฆฌ:

    • ๋ฉ”์ธ ํŽ˜์ด์ง€์˜ ๋ฐฐ๋„ˆ, ์นดํ…Œ๊ณ ๋ฆฌ ๊ด€๋ฆฌ (๋“ฑ๋ก, ์ˆ˜์ •, ์‚ญ์ œ ๊ธฐ๋Šฅ)
  • ์žฅ๋ฐ”๊ตฌ๋‹ˆ ๊ด€๋ฆฌ:

    • (ํšŒ์›)์žฅ๋ฐ”๊ตฌ๋‹ˆ ๊ธฐ๋Šฅ
  • ์ฃผ๋ฌธ ๋ฐ ๊ฒฐ์ œ:

    • ํšŒ์›/๋น„ํšŒ์›์˜ ์ฃผ๋ฌธ ๋ฐ ๊ฒฐ์ œ ์ฒ˜๋ฆฌ ๊ธฐ๋Šฅ

4. Tasks & Responsibilities (์ž‘์—… ๋ฐ ์—ญํ•  ๋ถ„๋‹ด)


์ด๋ฆ„ ์—ญํ•  ๊ฐœ๋ฐœ ์ž‘์—…
์•ˆ์šฐ์ง„ ํŒ€์žฅ * ์„œ๋ฒ„ ๊ตฌ์ถ• ๋ฐ ์šด์šฉ
* ํ”„๋กœ๋ชจ์…˜ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
* ์žฅ๋ฐ”๊ตฌ๋‹ˆ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
๊น€ํƒœ์šฐ ํŒ€์› * ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜ (๊ธฐ์—… ๋ฐ FE)
* ํšŒ์›๊ฐ€์ž… / ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
* ๊ฒฐ์ œ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
* ์ƒํ’ˆ ๊ด€๋ฆฌ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
๊ฐ•์Šน์ง„ ํŒ€์› * ๋ฐฐ๋„ˆ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
* ๊ฒฐ์ œ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
์ •๋ฏผ์ค€ ํŒ€์› * ์นดํ…Œ๊ณ ๋ฆฌ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
*์ฃผ๋ฌธ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
*๊ฒฐ์ œ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ

5. Technology Stack (๊ธฐ์ˆ  ์Šคํƒ)


5.1 ๋ฐฑ์—”๋“œ ๊ธฐ์ˆ  ์Šคํƒ

ํ•ญ๋ชฉ ๊ธฐ์ˆ  ์„ค๋ช…
ํ”„๋กœ๊ทธ๋ž˜๋ฐ ์–ธ์–ด Python Python ๊ธฐ๋ฐ˜์˜ ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ๊ฐœ๋ฐœ
์›น ํ”„๋ ˆ์ž„์›Œํฌ FastAPI Python ๊ธฐ๋ฐ˜์˜ ํ˜„๋Œ€์ ์ด๊ณ  ๋น ๋ฅธ ์›น ํ”„๋ ˆ์ž„์›Œํฌ
๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค MySQL DB for MySQL (NCP) ์„œ๋น„์Šค๋ฅผ ์ด์šฉํ•˜์—ฌ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์‹คํ–‰ ์ค‘
ORM Tortoise-ORM Python ORM ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋กœ, ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์ž‘์—…์„ ์ฒ˜๋ฆฌ
๊ฒฐ์ œ ์‹œ์Šคํ…œ PortOne(ํฌํŠธ์›) ๊ฒฐ์ œ ์ฒ˜๋ฆฌ ๋ฐ ๊ด€๋ จ ์„œ๋น„์Šค ์—ฐ๋™
Redis Redis ๋ฐ์ดํ„ฐ ์บ์‹ฑ ๋ฐ ์„ธ์…˜ ๊ด€๋ฆฌ์šฉ์œผ๋กœ ์‚ฌ์šฉ
์›น ์„œ๋ฒ„ Apache2 FastAPI ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ๋ฐฐํฌํ•˜๊ธฐ ์œ„ํ•œ ์›น ์„œ๋ฒ„
๋ณด์•ˆ SSL/TLS ์ธ์ฆ์„œ HTTPS๋ฅผ ์ง€์›ํ•˜๊ธฐ ์œ„ํ•ด NCP ๋กœ๋“œ ๋ฐธ๋Ÿฐ์„œ์— SSL ์ธ์ฆ์„œ ๋“ฑ๋ก
๋ฐฐํฌ ํ™˜๊ฒฝ Naver Cloud Platform (NCP) ์„œ๋ฒ„ ํ˜ธ์ŠคํŒ… ๋ฐ ์šด์˜
JWT ์ธ์ฆ JWT (Json Web Token) OAuth๋ฅผ ํ†ตํ•ด ์ธ์ฆ๋œ ์‚ฌ์šฉ์ž์—๊ฒŒ JWT ํ† ํฐ์„ ๋ฐœ๊ธ‰
์ฝ”๋“œ ํ’ˆ์งˆ ๊ฒ€์‚ฌ * MyPy
* isort
* black
* Python ์ฝ”๋“œ์˜ ์ •์  ํƒ€์ž… ๊ฒ€์‚ฌ
* import ์ •๋ ฌ ํ™•์ธ
* ์ฝ”๋“œ ์Šคํƒ€์ผ ํ™•์ธ
ํ…Œ์ŠคํŠธ ํ”„๋ ˆ์ž„์›Œํฌ pytest FastAPI ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์˜ ์œ ๋‹› ํ…Œ์ŠคํŠธ์™€ ํ†ตํ•ฉ ํ…Œ์ŠคํŠธ๋ฅผ ์‹คํ–‰

5.2 NCP ์ด์šฉ ์„œ๋น„์Šค

์„œ๋น„์Šค ์ข…๋ฅ˜ ์„œ๋น„์Šค ์ด๋ฆ„ ์„ค๋ช…
์„œ๋ฒ„ Server (VPC) ๊ฐ€์ƒ ์‚ฌ์„ค ํด๋ผ์šฐ๋“œ ํ™˜๊ฒฝ์—์„œ ์„œ๋ฒ„ ์ธ์Šคํ„ด์Šค๋ฅผ ์ƒ์„ฑ ๋ฐ ๊ด€๋ฆฌ.
๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค DB for MySQL MySQL ๊ธฐ๋ฐ˜์˜ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๊ด€๋ฆฌ ์„œ๋น„์Šค.
๋กœ๋“œ ๋ฐธ๋Ÿฐ์‹ฑ Load Balancer ๋„คํŠธ์›Œํฌ ํŠธ๋ž˜ํ”ฝ์„ ์—ฌ๋Ÿฌ ์„œ๋ฒ„๋กœ ๋ถ„์‚ฐํ•˜์—ฌ ๊ณ ๊ฐ€์šฉ์„ฑ์„ ์ œ๊ณต.
์Šคํ† ๋ฆฌ์ง€ Block Storage ์„œ๋ฒ„์— ์—ฐ๊ฒฐ๋œ ๊ณ ์† ์ €์žฅ ์žฅ์น˜.
DNS ๊ด€๋ฆฌ Global DNS ์ „ ์„ธ๊ณ„์— ๊ฑธ์ณ DNS ์„ค์ •์„ ๊ด€๋ฆฌํ•˜๊ณ  ๊ณ ์† ์‘๋‹ต ์ œ๊ณต.
๋„คํŠธ์›Œํฌ Network VPC, ์„œ๋ธŒ๋„ท, ๋ฐฉํ™”๋ฒฝ ๋“ฑ ๋„คํŠธ์›Œํฌ ๋ฆฌ์†Œ์Šค๋ฅผ ๊ตฌ์„ฑ ๋ฐ ๊ด€๋ฆฌ.
์˜ค๋ธŒ์ ํŠธ ์Šคํ† ๋ฆฌ์ง€ Object Storage ๋Œ€๋Ÿ‰์˜ ๋น„์ •ํ˜• ๋ฐ์ดํ„ฐ๋ฅผ ์ €์žฅํ•  ์ˆ˜ ์žˆ๋Š” ์Šคํ† ๋ฆฌ์ง€ ์„œ๋น„์Šค.
๊ณต์ธ IP Public IP ์ธํ„ฐ๋„ท์—์„œ ์ ‘๊ทผ ๊ฐ€๋Šฅํ•œ ๊ณต์ธ IP ์ฃผ์†Œ ์ œ๊ณต.

6. ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ


backend/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ app/
โ”‚   โ”‚   โ”œโ”€โ”€ banner/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ dtos/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ models/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ services/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py 
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ router.py
โ”‚   โ”‚   โ”œโ”€โ”€ cart/
โ”‚   โ”‚   โ”œโ”€โ”€ category/
โ”‚   โ”‚   โ”œโ”€โ”€ order/
โ”‚   โ”‚   โ”œโ”€โ”€ payment/
โ”‚   โ”‚   โ”œโ”€โ”€ product/
โ”‚   โ”‚   โ”œโ”€โ”€ promotion_product/
โ”‚   โ”‚   โ””โ”€โ”€ user/
โ”‚   โ”œโ”€โ”€ common/
โ”‚   โ”‚   โ”œโ”€โ”€ constants/
โ”‚   โ”‚   โ”œโ”€โ”€ exceptions/
โ”‚   โ”‚   โ”œโ”€โ”€ github_webhook/
โ”‚   โ”‚   โ”œโ”€โ”€ handlers/
โ”‚   โ”‚   โ”œโ”€โ”€ middlewares/
โ”‚   โ”‚   โ”œโ”€โ”€ models/
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ base_model.py
โ”‚   โ”‚   โ”œโ”€โ”€ utils/
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚   โ””โ”€โ”€ post_construct.py
โ”‚   โ”œโ”€โ”€ core/
โ”‚   โ”‚   โ”œโ”€โ”€ configs/         
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ settings.py
โ”‚   โ”‚   โ”œโ”€โ”€ database/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ db_settings.py 
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ models.py      
โ”‚   โ”‚   โ””โ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ tests/
โ”‚   โ”œโ”€โ”€ .env                # ํ™˜๊ฒฝ ๋ณ€์ˆ˜ ํŒŒ์ผ
โ”‚   โ”œโ”€โ”€ conftest.py
โ”‚   โ”œโ”€โ”€ main.py
โ”‚   โ”œโ”€โ”€ poetry.lock
โ”‚   โ”œโ”€โ”€ pyproject.toml
โ”‚   โ”œโ”€โ”€ start_gunicorn.sh       # ์„œ๋ฒ„ ์‹คํ–‰ ์Šคํฌ๋ฆฝํŠธ
โ”‚   โ””โ”€โ”€ test.sh
โ”œโ”€โ”€ .gitignore
โ”œโ”€โ”€ docker-compose.yml
โ”œโ”€โ”€ docker-compose-mysql.yml
โ”œโ”€โ”€ Dockerfile
โ””โ”€โ”€ README.md

7. ๊ฐœ๋ฐœ ์›Œํฌํ”Œ๋กœ์šฐ (Development Workflow)


๋ธŒ๋žœ์น˜ ์ „๋žต (Branch Strategy)

์šฐ๋ฆฌ์˜ ๋ธŒ๋žœ์น˜ ์ „๋žต์€ Git Flow๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•˜๋ฉฐ, ๋‹ค์Œ๊ณผ ๊ฐ™์€ ๋ธŒ๋žœ์น˜๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค:

  • develop ๋ธŒ๋žœ์น˜

    • ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์•ˆ์ •์ ์ธ ์ฝ”๋“œ๋ฅผ ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค.
    • ๋ชจ๋“  ๋ฐฐํฌ๋Š” ์ด ๋ธŒ๋žœ์น˜์—์„œ ์ด๋ฃจ์–ด์ง‘๋‹ˆ๋‹ค.
  • Feature ๋ธŒ๋žœ์น˜

    • ๊ฐ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์„ ์œ„ํ•œ ๋ธŒ๋žœ์น˜์ž…๋‹ˆ๋‹ค.
    • feature/{๊ธฐ๋Šฅ๋ช…} ํ˜•์‹์œผ๋กœ ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.
    • ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ์™„๋ฃŒ ํ›„ develop ๋ธŒ๋žœ์น˜๋กœ ๋ณ‘ํ•ฉํ•ฉ๋‹ˆ๋‹ค.

8. ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜ (Commit Convention)


์•„๋ž˜ Gitmoji ๊ทœ์น™์„ ์ฐธ๊ณ ํ•˜์—ฌ ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ํ…œํ”Œ๋ฆฟ์— ์ž‘์„ฑํ•จ

8.1 Gitmoji

  • โœจ feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
  • ๐Ÿ› fix: ๊ธฐ๋Šฅ ์ˆ˜์ •, ๋ฒ„๊ทธ ์ˆ˜์ •
  • ๐Ÿ’ก chore: ์˜คํƒ€ ์ˆ˜์ • ๋ฐ ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์ด ์ถ”๊ฐ€๋˜์ง€ ์•Š๊ณ , ์ฝ”๋“œ๊ฐ€ ๋ณ€๊ฒฝ๋œ ๊ฒฝ์šฐ (์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ์ˆ˜์ • ํฌํ•จ)
  • ๐Ÿ“ docs: ๋ฌธ์„œ ์ˆ˜์ • (README ์ˆ˜์ • ์‹œ)
  • ๐Ÿšš build: ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ • ๋ฐ ์‚ญ์ œํ•œ ๊ฒฝ์šฐ
  • โœ… test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ„ฐ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€ (ํ”„๋กœ๋•์…˜ ์ฝ”๋“œ ๋ณ€๊ฒฝ X)
  • โ™ป๏ธ refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ„ฐ๋ง
  • ๐Ÿš‘ hotfix: ๊ธด๊ธ‰ ์ˆ˜์ •

8.2 ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ํ…œํ”Œ๋ฆฟ

์ œ๋ชฉ (ํ•„์ˆ˜)
์ด๋ชจ์ง€ ๋ฐ ํƒ€์ž…์„ ์ถ”๊ฐ€ํ•˜์—ฌ 50์ž ์ด๋‚ด๋กœ ๋ณ€๊ฒฝ์‚ฌํ•ญ์„ ๊ฐ„๋‹จํ•˜๊ฒŒ ์š”์•ฝํ•˜์„ธ์š”.
์˜ˆ: โœจ feat: ์ƒˆ๋กœ์šด ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ์ถ”๊ฐ€

๋ณธ๋ฌธ (์„ ํƒ)
๋ณ€๊ฒฝํ•œ ์ด์œ ๋ฅผ ์ƒ์„ธํ•˜๊ฒŒ ์„ค๋ช…ํ•˜์„ธ์š”. ์—ฌ๋Ÿฌ ์ค„์ผ ๊ฒฝ์šฐ, ๊ฐ ์ค„์˜ ๊ธธ์ด๋Š” 72์ž๋ฅผ ๋„˜์ง€ ์•Š๊ฒŒ ์ž‘์„ฑํ•˜์„ธ์š”.
์˜ˆ์‹œ:

  • ์ด์œ  1
  • ์ด์œ  2

Footer (์„ ํƒ)
๊ด€๋ จ๋œ ์ด์Šˆ ๋ฒˆํ˜ธ๋‚˜ ์ฐธ๊ณ  ์ •๋ณด๋ฅผ ์ถ”๊ฐ€ํ•˜์„ธ์š”.
์˜ˆ์‹œ: Resolves: 123

8.3 ์ปจ๋ฒค์…˜ ์ˆ˜ํ–‰ ๊ฒฐ๊ณผ

git convention

9. Continuous Integration / Continuous Deployment (CI/CD)


9.1 GitHub Actions๋ฅผ ์ด์šฉํ•œ CI/CD ์›Œํฌํ”Œ๋กœ์šฐ

GitHub Actions๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ฝ”๋“œ๊ฐ€ ์›๊ฒฉ ์ €์žฅ์†Œ์— ํ‘ธ์‹œ๋  ๋•Œ๋งˆ๋‹ค CI/CD ํŒŒ์ดํ”„๋ผ์ธ์„ ์‹คํ–‰
ํ•ด๋‹น workflow ๋Š” ์ฝ”๋“œ ํ’ˆ์งˆ์„ ์œ ์ง€ํ•˜๊ณ  ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์˜ ์•ˆ์ •์„ฑ์„ ํ™•๋ณดํ•˜๊ธฐ ์œ„ํ•ด ๋‹ค์–‘ํ•œ ์ž‘์—…์„ ์ž๋™์œผ๋กœ ์ˆ˜ํ–‰

9.2 ์›Œํฌํ”Œ๋กœ์šฐ ํŒŒ์ผ ์œ„์น˜

  • .github/workflows/fastapi-ci.yml

9.3 CI/CD Detail

1. ํŠธ๋ฆฌ๊ฑฐ ์กฐ๊ฑด

  • Push ์ด๋ฒคํŠธ: ์ฝ”๋“œ๊ฐ€ ์ €์žฅ์†Œ์— push๋  ๋•Œ ์ž๋™ ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค.

2. ์‹คํ–‰ ํ™˜๊ฒฝ

  • ์šด์˜ ์ฒด์ œ: Ubuntu 20.04
  • Python ๋ฒ„์ „: 3.12

3. ํ™˜๊ฒฝ ๋ณ€์ˆ˜

  • ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์„ค์ •์€ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ํ™˜๊ฒฝ ๋ณ€์ˆ˜๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค:
  • DB_HOST: 127.0.0.1
  • DB_PORT: 3306
  • DB_USER: root
  • DB_PASSWORD: 1234
  • DB_DATABASE: oz_fastapi

4. ์ฃผ์š” ์ž‘์—… ๋‹จ๊ณ„

4.1. ์ฝ”๋“œ ์ฒดํฌ์•„์›ƒ
์ €์žฅ์†Œ์˜ ์ฝ”๋“œ๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค.

4.2. Python ํ™˜๊ฒฝ ์„ค์ •

  • Python 3.12 ๋ฒ„์ „์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.
  • ํ•œ๊ตญ ์‹œ๊ฐ„๋Œ€(KST)๋กœ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค.

4.3. MySQL ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์ดˆ๊ธฐํ™”

  • MySQL ์„œ๋ฒ„๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค.
  • ์ง€์ •๋œ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ฐ ์‚ฌ์šฉ์ž ์„ค์ •์„ ๊ตฌ์„ฑํ•ฉ๋‹ˆ๋‹ค.

4.4. ์˜์กด์„ฑ ์„ค์น˜

  • Poetry๋ฅผ ์„ค์น˜ํ•˜๊ณ  ํ”„๋กœ์ ํŠธ์˜ ์˜์กด์„ฑ์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

4.5. ์ฝ”๋“œ ํ’ˆ์งˆ ๊ฒ€์‚ฌ

  • black: ์ฝ”๋“œ ์Šคํƒ€์ผ ํ™•์ธ.
  • isort: ์ž„ํฌํŠธ ์ •๋ ฌ ํ™•์ธ.
  • mypy: ์ •์  ํƒ€์ž… ๊ฒ€์‚ฌ.

4.6. ํ…Œ์ŠคํŠธ ์‹คํ–‰

  • pytest: ํ…Œ์ŠคํŠธ ์‹คํ–‰ ๋ฐ ์ฝ”๋“œ ์ปค๋ฒ„๋ฆฌ์ง€ ๋ณด๊ณ ์„œ ์ƒ์„ฑ.

9.4 CI/CD ์ˆ˜ํ–‰ ๊ฒฐ๊ณผ

git convention

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages