Skip to content

Commit ac93bfc

Browse files
committed
major update
major update
1 parent 9ea8701 commit ac93bfc

11 files changed

Lines changed: 39 additions & 8 deletions

โ€ŽREADME.mdโ€Ž

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,14 @@ source venv/bin/activate # Linux/Mac
100100
venv\Scripts\activate # Windows
101101

102102
# 3. ๅฎ‰่ฃ…ไพ่ต–
103-
pip install -r requirements.txt
103+
pip install -r config/requirements.txt
104104

105105
# 4. ้…็ฝฎ็Žฏๅขƒๅ˜้‡
106-
cp .env.example .env
106+
cp config/.env.example .env
107107
# ็ผ–่พ‘.envๆ–‡ไปถ๏ผŒๅกซๅ…ฅๅฟ…่ฆ็š„APIๅฏ†้’ฅๅ’Œ้…็ฝฎ
108108

109109
# 5. ๅฏๅŠจๆœๅŠก
110-
docker-compose up -d
110+
docker-compose -f deployment/docker-compose.yml up -d
111111

112112
# 6. ้ชŒ่ฏๆœๅŠก็Šถๆ€
113113
curl http://localhost:8000/health
@@ -126,6 +126,9 @@ pytest tests/ -v
126126
flake8 app/
127127
black app/
128128
mypy app/
129+
130+
# ่ฟ่กŒ้…็ฝฎๆฃ€ๆŸฅ
131+
python scripts/health_check.py
129132
```
130133

131134
## ๐Ÿ“ ้กน็›ฎ็ป“ๆž„
@@ -172,11 +175,21 @@ mcp4coder/
172175
โ”‚ โ””โ”€โ”€ Dockerfile # ๅบ”็”จ้•œๅƒ
173176
โ”œโ”€โ”€ docs/ # ้กน็›ฎๆ–‡ๆกฃ
174177
โ”œโ”€โ”€ logs/ # ๆ—ฅๅฟ—็›ฎๅฝ•
175-
โ”œโ”€โ”€ requirements.txt # Pythonไพ่ต–
176-
โ”œโ”€โ”€ docker-compose.yml # Docker็ผ–ๆŽ’
177-
โ”œโ”€โ”€ pytest.ini # ๆต‹่ฏ•้…็ฝฎ
178-
โ”œโ”€โ”€ .env.example # ็Žฏๅขƒๅ˜้‡็คบไพ‹
179-
โ””โ”€โ”€ README.md # ้กน็›ฎ่ฏดๆ˜Ž
178+
โ”œโ”€โ”€ config/ # ้…็ฝฎๆ–‡ไปถ็›ฎๅฝ•
179+
โ”‚ โ”œโ”€โ”€ .env.example # ็Žฏๅขƒๅ˜้‡็คบไพ‹
180+
โ”‚ โ”œโ”€โ”€ requirements.txt # Pythonๅผ€ๅ‘ไพ่ต–
181+
โ”‚ โ”œโ”€โ”€ requirements-prod.txt # ็”Ÿไบง็Žฏๅขƒไพ่ต–
182+
โ”‚ โ””โ”€โ”€ pytest.ini # ๆต‹่ฏ•้…็ฝฎ
183+
โ”œโ”€โ”€ deployment/ # ้ƒจ็ฝฒ้…็ฝฎ็›ฎๅฝ•
184+
โ”‚ โ”œโ”€โ”€ docker-compose.yml # ๅผ€ๅ‘็ŽฏๅขƒDocker็ผ–ๆŽ’
185+
โ”‚ โ””โ”€โ”€ docker-compose.prod.yml # ็”Ÿไบง็ŽฏๅขƒDocker็ผ–ๆŽ’
186+
โ”œโ”€โ”€ documentation/ # ๆ–‡ๆกฃ็›ฎๅฝ•
187+
โ”‚ โ”œโ”€โ”€ README_PROFESSIONAL.md # ไธ“ไธš็‰ˆREADME
188+
โ”‚ โ”œโ”€โ”€ CHANGELOG.md # ๆ›ดๆ–ฐๆ—ฅๅฟ—
189+
โ”‚ โ”œโ”€โ”€ PROJECT_SUMMARY.md # ้กน็›ฎๆ€ป็ป“
190+
โ”‚ โ””โ”€โ”€ SECURITY_CHECKLIST.md # ๅฎ‰ๅ…จๆฃ€ๆŸฅๆธ…ๅ•
191+
โ”œโ”€โ”€ LICENSE # ๅผ€ๆบ่ฎธๅฏ่ฏ
192+
โ””โ”€โ”€ README.md # ้กน็›ฎ่ฏดๆ˜Ž(ไธปๆ–‡ๆกฃ)
180193
```
181194

182195
## โš™๏ธ ้…็ฝฎ่ฏดๆ˜Ž
@@ -228,6 +241,9 @@ COMMUTE_CHECK_CRON=0 30 8 * * * # ๆฏๅคฉ8:30ๆ‰ง่กŒ
228241
```bash
229242
# ๅฏๅŠจๅผ€ๅ‘ๆจกๅผ้ชŒ่ฏ้…็ฝฎ
230243
python -c "from app.config.settings import settings; print('้…็ฝฎๅŠ ่ฝฝๆˆๅŠŸ')"
244+
245+
# ่ฟ่กŒๅฅๅบทๆฃ€ๆŸฅ
246+
python scripts/health_check.py
231247
```
232248

233249
## ๐Ÿงช ๆต‹่ฏ•
@@ -342,6 +358,21 @@ docker-compose restart
342358
docker-compose down
343359
```
344360

361+
## ๐Ÿ“š ็›ธๅ…ณๆ–‡ๆกฃ
362+
363+
| ๆ–‡ๆกฃ | ่ทฏๅพ„ | ่ฏดๆ˜Ž | ้€‚็”จไบบ็พค |
364+
|------|------|------|----------|
365+
| [ๅฐ็™ฝๆจกๅผ่ฏดๆ˜Ž](dumb_mode/README_DUMB.md) | `dumb_mode/README_DUMB.md` | 5ๅˆ†้’Ÿๅฟซ้€ŸไธŠๆ‰‹ๆŒ‡ๅ— | ๆ–ฐๆ‰‹็”จๆˆท |
366+
| [ๆžถๆž„่ฎพ่ฎกๆ–‡ๆกฃ](docs/architecture.md) | `docs/architecture.md` | ็ณป็ปŸๆžถๆž„่ฏฆ่งฃ | ๅผ€ๅ‘่€… |
367+
| [APIๆŽฅๅฃๆ–‡ๆกฃ](docs/api_reference.md) | `docs/api_reference.md` | RESTful API่ฏดๆ˜Ž | ๅผ€ๅ‘่€… |
368+
| [้ƒจ็ฝฒๆ‰‹ๅ†Œ](docs/deployment.md) | `docs/deployment.md` | ็”Ÿไบง็Žฏๅขƒ้ƒจ็ฝฒๆŒ‡ๅ— | ่ฟ็ปดไบบๅ‘˜ |
369+
| [ๅผ€ๅ‘ๆŒ‡ๅ—](docs/development.md) | `docs/development.md` | ่ดก็Œฎๅ’Œๅผ€ๅ‘่ฏดๆ˜Ž | ๅผ€ๅ‘่€… |
370+
| [ๅฟซ้€Ÿๅผ€ๅง‹ๆŒ‡ๅ—](docs/quick_start_guide.md) | `docs/quick_start_guide.md` | ่ฏฆ็ป†ๆ“ไฝœๆญฅ้ชค | ๆ‰€ๆœ‰็”จๆˆท |
371+
| [ๆ›ดๆ–ฐๆ—ฅๅฟ—](documentation/CHANGELOG.md) | `documentation/CHANGELOG.md` | ็‰ˆๆœฌๅ˜ๆ›ด่ฎฐๅฝ• | ๆ‰€ๆœ‰็”จๆˆท |
372+
| [้กน็›ฎๆ€ป็ป“](documentation/PROJECT_SUMMARY.md) | `documentation/PROJECT_SUMMARY.md` | ๅฎŒๆ•ด้กน็›ฎๆŠฅๅ‘Š | ็ฎก็†่€… |
373+
| [ๅฎ‰ๅ…จๆฃ€ๆŸฅ](documentation/SECURITY_CHECKLIST.md) | `documentation/SECURITY_CHECKLIST.md` | ๅฎ‰ๅ…จ้…็ฝฎๆธ…ๅ• | ๅฎ‰ๅ…จไบบๅ‘˜ |
374+
| [ไธ“ไธš็‰ˆREADME](documentation/README_PROFESSIONAL.md) | `documentation/README_PROFESSIONAL.md` | ่ฏฆ็ป†ๆŠ€ๆœฏๆ–‡ๆกฃ | ๅผ€ๅ‘่€… |
375+
345376
## ๐Ÿค ่ดก็ŒฎๆŒ‡ๅ—
346377

347378
ๆฌข่ฟŽๆไบคIssueๅ’ŒPull Request๏ผ
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
ย (0)