https://github.com/prgrms-fullcycle-devcourse/webfull_9_10_todam
당신의 작품이 머무는 시간, 토담
https://github.com/prgrms-fullcycle-devcourse/webfull_9_10_todam
Last synced: 1 day ago
JSON representation
당신의 작품이 머무는 시간, 토담
- Host: GitHub
- URL: https://github.com/prgrms-fullcycle-devcourse/webfull_9_10_todam
- Owner: prgrms-fullcycle-devcourse
- License: mit
- Created: 2026-05-22T08:28:43.000Z (about 1 month ago)
- Default Branch: dev
- Last Pushed: 2026-06-14T01:10:04.000Z (17 days ago)
- Last Synced: 2026-06-14T03:10:39.157Z (17 days ago)
- Language: TypeScript
- Homepage: https://todam.app
- Size: 7.12 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Agents: AGENTS.md
Awesome Lists containing this project
README
# 토담 - 공방 원데이 클래스 예약 플랫폼 
토담은 사용자가 공방의 클래스를 탐색하고 예약하며,
파트너는 공방, 클래스, 예약, 작품의 진행 상태를 유저에게 안내하고 관리할 수 있는 공방/예약 운영 플랫폼입니다.
## 🧩 Quick Link
- 🏠 [서비스 바로가기](https://todam.app)
- 🎬 [데모 영상](https://youtu.be/gK5Zry9Wcy4)
- 📚 [전체 문서 보기](#-documents)
## 👋 Introduction
todam은 공방 원데이 클래스를 찾고 예약하는 사용자, 공방을 운영하는 파트너, 서비스를 관리하는 운영자를 위한 흐름을 제공합니다.
- **사용자**: 공방 및 클래스 탐색, 예약 신청, 작품 진행 상황 조회, 리뷰 작성
- **파트너**: 공방 및 클래스 등록, 예약/일정 관리, 작품 진행 관리, 사업자 인증
- **운영자**: 파트너 승인, 공방 검수, 신고 처리, 서비스 운영 관리
> **기간**: 2026.05.18 ~ 2026.06.18
> **팀 구성**: FE 3명, BE 2명
## 🏛️ Architecture
- `web(Next.js)`은 클래스 참여자/파트너 화면을 제공하고, `api(NestJS)`는 인증·예약·작품·공방·알림 도메인을 처리합니다.
- 데이터는 `RDS(PostgreSQL)`, 큐와 인증 코드는 `Redis`, 이미지는 `S3 presigned URL` 기반 업로드로 관리합니다.
- 메일은 `AWS SES`, 웹 푸시는 `FCM`으로 발송하며, 배포는 GitHub Actions → ECR → EC2 흐름으로 진행합니다.
## 🧠 Key Design Points
### 🔐 1. 역할별 접근 흐름 분리
사용자, 파트너, 운영자 흐름을 분리하고 각 화면에서 필요한 권한만 노출합니다. 서버에서는 인증 상태, 파트너 승인 여부, 리소스 소유권을 함께 검증해 권한 상승을 방지합니다.
### 📅 2. 예약 시점 타임슬롯 자동 생성
공방 운영시간, 예약 간격, 예약 제한, 기존 예약 수를 기준으로 예약 가능한 시간을 계산합니다. 프론트엔드는 가능한 시간만 선택지로 보여주고, 서버는 예약 생성 시점에 타임슬롯을 생성한 뒤 다시 검증해 동시 예약 시에도 정원 초과 없이 처리합니다.
### 🔄 3. 예약·작품 상태의 단일 기준
예약 상태와 작품 제작 단계는 서버에서 `displayState`로 계산해 내려줍니다. 예를 들어 제작 중 구간은 건조·초벌·유약·재벌 단계까지 서버가 결정하고, 프론트엔드는 같은 응답 값을 사용자 화면, 마이페이지, 파트너 화면에서 일관되게 렌더링합니다.
### 🔔 4. 알림과 사용자 피드백
예약 확정, 취소, 작품 상태 변경 같은 이벤트는 인앱 알림과 웹 푸시로 전달합니다. 알림 발송은 비동기로 분리해 핵심 예약·작품 흐름이 외부 발송 실패에 영향을 받지 않도록 했습니다.
### 🪪 5. 파트너 등록과 이미지 업로드
파트너는 사업자등록증과 공방 이미지를 업로드해 공방 등록을 진행합니다. 이미지는 S3 presigned URL로 직접 업로드하고, 사업자등록증은 OCR과 진위확인 API를 통해 검증합니다.
## 🖥️ Tech Stack
**Common**
**Frontend**
**Backend**
**Infra & External**
## 📂 Directory Structure
```text
todam/
├── apps/
│ ├── api/ # NestJS 백엔드
│ ├── web/ # Next.js 클래스 참여자·파트너 서비스
│ ├── admin/ # Vite 운영자 서비스
│ └── storybook/ # 공통 UI 문서화
├── packages/
│ ├── shared/ # 공통 enum, type, schema, 상태 계산
│ ├── ui/ # web/admin 공통 UI 컴포넌트
│ ├── config/ # 환경변수 검증
│ ├── eslint-config/ # 공유 ESLint 설정
│ └── typescript-config/ # 공유 TypeScript 설정
├── docs/ # 요구사항, API, 실행 계획, 컨벤션 문서
├── docker/ # 로컬/배포 인프라 구성
└── scripts/ # 개발 보조 스크립트
```
## 🗄️ Database Schema
> 사용자는 공방과 클래스를 탐색해 예약을 생성하고, 예약 이후 작품 제작 상태, 배송, 리뷰, 알림 데이터가 연결됩니다.
> 파트너는 공방과 클래스 운영 정보, 예약 가능 시간, 사업자 인증 정보, 작품 제작 진행 상태를 관리합니다.
## 📚 Documents
- [기능 요구사항](docs/requirements.md)
- [API 명세](docs/api/apispec.md)
- [시스템 아키텍처](ARCHITECTURE.md)
- [UI/디자인 규칙](DESIGN.md)
- [코드/환경 컨벤션](docs/conventions/README.md)
## 👥 Contributors
Profile
Name
Role
Contributions
이은지
FE
디자인 시스템 · FSD 설계 · 파트너 전용 기능 · 인증 · 온보딩 게이트 · 알림 FCM · PWA · CI/CD · AI 자동화
이승훈
FE
공통 폼 · 인터랙션 UI · 로그인 · OAuth 플로우 · 온보딩 바텀시트 · 예약 시간 표기
한윤지
FE
공통 UI · FSD 정합 · 인증 · 공방 · 예약 FE · 작품 · 리뷰 · 마이 FE · MSW→실 BE 전환 주도
최태성
BE
DB 스키마 · 마이그레이션 · 파트너 도메인 API 전체 · 타임슬롯 · 상태 전이 · OCR · 진위확인 게이트 · BE AWS 배포
이재혁
BE
API 계약 · 정합 문서화 · 회원 인증 · 소셜 OAuth · 공방 · 예약 · 작품 BE · 알림 BE 파이프라인