Skip to content

Commit ee24fb4

Browse files
authored
Revise README for better structure and clarity
Updated README to improve clarity and organization of modules, requirements, and setup instructions.
1 parent 84a7d22 commit ee24fb4

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,37 +66,33 @@ API → Application → Domain ← Infrastructure
6666
- **Infrastructure**: Domain 인터페이스를 구현
6767
- **API**: Application을 호출하여 HTTP 요청 처리
6868

69-
## 주요 모듈
69+
## Main Modules
7070

7171
### `users`
72-
사용자 관리 모듈
7372
- 사용자 생성/조회/수정
7473
- 사주 정보 저장 및 조회
7574

7675
### `four_pillars`
77-
사주 계산 모듈
7876
- 생년월일 기반 사주 계산
7977
- 오행, 십신 분석
8078
- HCX API를 통한 사주 설명 생성
8179

8280
### `fortune`
83-
운세 모듈
8481
- 일일 운세 제공
8582
- 사주 기반 운세 분석
8683

8784
### `lotto`
88-
로또 추천 모듈
8985
- 사주 기반 로또 번호 추천
9086
- 로또 통계 및 당첨 확인
9187

92-
## 시작하기
88+
## Local Server Settings
9389

94-
### 요구사항
90+
### Requirements
9591
- Python 3.13+
9692
- MySQL
9793
- uv (패키지 관리자)
9894

99-
### 설치
95+
### 환경 세팅
10096

10197
```bash
10298
# 의존성 설치
@@ -109,11 +105,7 @@ cp .env.example .env
109105
### 실행
110106

111107
```bash
112-
# 개발 서버 실행
113-
uvicorn src.main:app --reload
114-
115-
# 프로덕션 실행
116-
gunicorn src.main:app -w 4 -k uvicorn.workers.UvicornWorker
108+
docker-compose -f docker-compose.local.yml up --build
117109
```
118110

119111
## 전체 프로젝트 구조
@@ -142,7 +134,7 @@ Satto-Server/
142134
- **Code Quality**: ruff, mypy
143135

144136

145-
## 개발
137+
## Development
146138

147139
### 코드 포맷팅
148140
```bash

0 commit comments

Comments
 (0)