[공지] UNMUTE 프로젝트 개발 시작 안내 (Scaffolding 완료)

[yeop-sang]

🚀 UNMUTE 프로젝트 개발 시작 안내

FastAPI 백엔드 스캐폴딩 및 Azure 인프라 배포가 완료되었습니다.
아래 가이드를 참고하여 개발 환경을 세팅하고 담당 기능을 구현해주세요.
반드시 브랜치는 엄격하게 관리할 것!

---

1. 🛠 공통 준비 사항 (필수)

1. Repository Clone

   git clone https://github.com/SKT8LL/fastapi-community.git
   cd fastapi-community

2. uv 설치 및 가상환경 세팅
   이 프로젝트는 패키지 관리를 위해 uv를 사용합니다.

   # uv 설치
   pip install uv
   
   # 가상환경 생성 및 활성화
   uv venv
   source .venv/bin/activate  # macOS/Linux
   # Windows: .venv\Scripts\activate

3. 의존성 설치

   uv pip install -r requirements.txt

4. 로컬 서버 실행 확인

   uv run uvicorn app.main:app --reload

   • 실행 후 http://127.0.0.1:8000/docs 접속 시 Swagger UI가 떠야 합니다.
   • Note: .env 파일이 이미 Azure Dev DB(japaneast)와 연결 설정되어 있으므로, 별도 DB 세팅 없이 바로 개발 가능합니다.
   • .env는 따로 요청 부탁드립니다.

---

2. 👥 담당 업무 분담

README.md의 기능 분담 섹션을 참고하세요.

🧑‍💻 정필상 (Places & Events)

• 목표: 공간(Place) 및 행사(Event) CRUD 기능 구현
• branch: feature/place_event
• 작업 파일:
  • app/routers/places.py: list_places, create_place 등 TODO 구현
  • app/routers/events.py: list_events, create_event 등 TODO 구현
• 체크포인트:
  • GET /places/{place_id}/events가 해당 공간의 이벤트 목록을 잘 반환하는지 확인

🧑‍💻 김진욱 (Deals & Docents)

• 목표: 핫딜(Deal) 및 AI 도슨트(Docent) 기능 구현
• branch: feature/deal_docent
• 작업 파일:
  • app/routers/deals.py: create_deal 및 POST /deals/recommend (할인율 로직) 구현
  • app/routers/docents.py: create_docent 및 POST /docents/generate (AI 텍스트 생성) 구현
• 체크포인트:
  • recommend API가 입력값(남은 좌석 등)에 따라 할인율을 동적으로 계산하는지 확인

---

3. ✅ 개발 규칙 & 주의사항

1. Git Flow
   • main 브랜치에 직접 Push 금지
   • 각자 Feature 브랜치 생성 후 작업 (feature/places-crud, feature/deals-logic 등)
2. 테스트 필수
   • 코드 작성 후 PR 올리기 전에 반드시 테스트를 수행하세요.

   pytest -v

3. 데이터베이스
   • 현재 Dev DB(unmute-db)를 공유해서 사용하므로, seed.py를 무분별하게 실행하여 데이터를 초기화하지 않도록 주의해주세요.

---