Skip to content

Commit ffbdff4

Browse files
committed
refactor: archive python backend to examples/ and optimize docs
- Move server/ to examples/backend-python/ (optional reference impl) - Remove duplicate changelog/CHANGELOG.zh-CN.md - Update docs: Node.js ≥22, version v2.1.0 - Enhance build-pages.sh with sitemap generation - Clean .gitignore: add *.tsbuildinfo, update comments - Add .vscode/ configs (mcp.json, settings.json)
1 parent 4146a70 commit ffbdff4

31 files changed

Lines changed: 74 additions & 229 deletions

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ dist/
66
dist-ssr/
77
build/
88
coverage/
9+
*.tsbuildinfo
910

1011
# Environment variables
1112
.env
@@ -15,6 +16,8 @@ coverage/
1516
# Editor directories and files
1617
.vscode/*
1718
!.vscode/extensions.json
19+
!.vscode/settings.json
20+
!.vscode/mcp.json
1821
.idea/
1922
*.suo
2023
*.ntvs*
@@ -29,7 +32,7 @@ Thumbs.db
2932
# Logs
3033
*.log
3134

32-
# Python (server/)
35+
# Python (examples/backend-python/)
3336
__pycache__/
3437
*.py[cod]
3538
.venv/

.vscode/mcp.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"servers": {
3+
"copilot-enhance-3210": {
4+
"type": "http",
5+
"url": "http://127.0.0.1:3210/mcp"
6+
}
7+
}
8+
}

.vscode/settings.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.defaultFormatter": "esbenp.prettier-vscode",
4+
"editor.codeActionsOnSave": {
5+
"source.fixAll.eslint": "explicit"
6+
},
7+
"typescript.tsdk": "node_modules/typescript/lib",
8+
"typescript.enablePromptUseWorkspaceTsdk": true,
9+
"typescript.preferences.importModuleSpecifier": "non-relative",
10+
"typescript.preferences.importModuleSpecifierEnding": "js",
11+
"files.associations": {
12+
"*.css": "tailwindcss"
13+
},
14+
"tailwindCSS.experimental.classRegex": [
15+
["clsx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
16+
],
17+
"search.exclude": {
18+
"**/node_modules": true,
19+
"**/dist": true,
20+
"**/coverage": true
21+
}
22+
}

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ Open **http://localhost:5173** — your 3D avatar is ready!
8282

8383
> 💡 **No API key required.** The engine automatically falls back to local mock mode for out-of-the-box demos.
8484
85+
> 🐍 **Optional Backend:** A FastAPI backend example is available in `examples/backend-python/` for custom integrations.
86+
8587
---
8688

8789
## 🎯 Features

README.zh-CN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ npm run dev
8282

8383
> 💡 **无需 API Key。** 引擎自动降级到本地模拟模式,开箱即用。
8484
85+
> 🐍 **可选后端:** 如需自定义集成,可参考 `examples/backend-python/` 中的 FastAPI 示例。
86+
8587
---
8688

8789
## 🎯 Features

changelog/CHANGELOG.zh-CN.md

Lines changed: 0 additions & 221 deletions
This file was deleted.

docs/guide/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Get MetaHuman Engine running in 5 minutes.
88

99
| Requirement | Version | Check Command |
1010
| ----------- | ------- | ------------------ |
11-
| Node.js | ≥ 20 | `node --version` |
12-
| npm | ≥ 9 | `npm --version` |
13-
| Python | ≥ 3.10 | `python --version` |
11+
| Node.js | ≥ 22 | `node --version` |
12+
| npm | ≥ 10 | `npm --version` |
1413
| Git | Any | `git --version` |
1514

15+
> 🐍 **Optional Backend:** A FastAPI backend example is available in `examples/backend-python/` for custom integrations. See backend setup instructions below.
16+
1617
---
1718

1819
## Installation
@@ -55,7 +56,8 @@ meta-human/
5556
│ │ └── vision/ # Face tracking
5657
│ ├── store/ # Zustand stores
5758
│ └── hooks/ # Custom hooks
58-
├── server/ # FastAPI backend
59+
├── examples/ # Optional backend examples
60+
│ └── backend-python/ # FastAPI reference implementation
5961
├── docs/ # Documentation
6062
├── public/ # Static assets
6163
└── dist/ # Build output
@@ -155,10 +157,12 @@ npm run build
155157
npm run test
156158
```
157159

158-
### Backend Development
160+
### Backend Development (Optional)
161+
162+
If you want to use a custom backend instead of the mock mode:
159163

160164
```bash
161-
cd server
165+
cd examples/backend-python
162166

163167
# Create virtual environment (recommended)
164168
python -m venv venv

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ MetaHuman Engine is a **browser-native 3D digital human engine** that provides a
106106

107107
## 📋 Version Information
108108

109-
**Current Version:** `v1.0.0`
109+
**Current Version:** `v2.1.0`
110110

111111
See [CHANGELOG](../CHANGELOG.md) for version history.
112112

0 commit comments

Comments
 (0)