Skip to content

Commit f410ce4

Browse files
authored
Merge pull request #61 from refeel-team/docs/문서화-작업-마무리
Docs/문서화 작업 마무리
2 parents 7f0f9bd + 299fba4 commit f410ce4

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

Model.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## 문서 - Refeel 모델
2+
3+
SwiftData 기반으로 설계되었으며, `Retrospect` 모델과 `Category` 열거형으로 구성되어 있습니다.
4+
5+
---
6+
7+
## 📘 모델: `Retrospect`
8+
9+
사용자가 하루 회고를 작성할 때 사용하는 주요 데이터 모델입니다.
10+
11+
| 필드명 | 타입 | 설명 | 제약조건 |
12+
| ---------- | --------- | ------------------------ | ------------------------------------- |
13+
| `id` | UUID | 고유 식별자 | Primary Key |
14+
| `date` | Date | 회고 작성 날짜 | Not Null, 하루 시작 시각으로 정규화됨 |
15+
| `content` | String? | 회고 내용 (선택사항) | Nullable |
16+
| `category` | Category? | 회고 카테고리 (선택사항) | Enum 참조 |
17+
18+
---
19+
20+
## 📗 열거형: `Category`
21+
22+
회고에 사용할 수 있는 카테고리 목록입니다. UI에서 한글로 표시되며, Enum의 raw value는 한글입니다.
23+
24+
| Enum 값 | Raw Value | 설명 |
25+
| --------- | --------- | -------------------- |
26+
| `workout` | "운동" | 운동 관련 활동 기록 |
27+
| `study` | "공부" | 학습 및 공부 기록 |
28+
| `work` | "업무" | 일 및 생산 활동 기록 |
29+
| `rest` | "휴식" | 여가 및 휴식 기록 |
30+
| `etc` | "기타" | 기타 활동 기록 |
31+
32+
---
33+
34+
## 🧩 확장 가능성
35+
36+
| 개선 방향 | 설명 |
37+
| ---------------- | ----------------------------------------------------------------- |
38+
| 감정 추가 | 감정 상태 (행복/슬픔 등) Enum으로 확장 가능 |
39+
| 태그(Tag) 기능 | 여러 키워드를 `Set<String>` 또는 별도 `Tag` 모델로 연결 가능 |
40+
| 사용자 모델 연동 | 다중 사용자 회고 지원을 위한 `User``Retrospect` 관계 도입 가능 |
41+
| 파일 첨부 기능 | 사진, 음성 등 미디어를 `Retrospect`에 연결 가능 |
42+
43+
## 📌 참고사항
44+
45+
- SwiftData의 `@Model`은 내부적으로 자동으로 id와 저장소를 관리합니다.
46+
- `Calendar.current.startOfDay(for:)`를 통해 `date`를 하루 기준으로 정규화하여 중복 기록 방지에 활용합니다.

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,49 @@ Refeel
110110
111111
112112
```
113+
114+
## 실행 방법
115+
116+
### 1. 프로젝트 클론
117+
118+
```bash
119+
git clone https://github.com/jihyeonjjang/HaruPocket.git
120+
cd HaruPocket
121+
```
122+
123+
### 2. Xcode에서 열기
124+
125+
- `HaruPocket.xcodeproj` 또는 `HaruPocket.xcworkspace`**Xcode 15 이상**에서 엽니다.
126+
127+
### 3. 패키지 설치 확인
128+
129+
- 프로젝트를 열면 자동으로 **EmojiPicker 2.1.1**이 설치됩니다.
130+
- 설치 오류가 발생할 경우 `File > Packages > Resolve Package Versions`를 선택하세요.
131+
132+
### 4. 실행
133+
134+
- 시뮬레이터 또는 실제 디바이스를 선택 후 ▶️ 버튼으로 실행합니다.
135+
136+
### 5. 미리보기 사용 (옵션)
137+
138+
- `#Preview` 구조와 `inMemory` 컨테이너를 이용해 SwiftUI 뷰 미리보기가 가능합니다.
139+
140+
---
141+
142+
## 실행 방법
143+
144+
### 1. 프로젝트 클론
145+
146+
```bash
147+
git clone https://github.com/refeel-team/refeel-app.git
148+
cd refeel-app
149+
```
150+
151+
### 2. Xcode에서 열기
152+
153+
- `Refeel.xcodeproj` 또는 `Refeel.xcworkspace ( **Xcode 15 이상 권장**)
154+
155+
### 3. 실행
156+
157+
- 시뮬레이터 또는 실제 디바이스를 선택 후 버튼으로 왼쪽 상단에 재생 버튼 또는 `Shift+R` 실행합니다.
158+
니다.

0 commit comments

Comments
 (0)