first commit

2026-07-22 13:48:46 +08:00
commit c87751c3dc
2820 changed files with 726976 additions and 0 deletions
@@ -0,0 +1,74 @@
+# CADDesigner Startup Guide
+
+The repository currently keeps one Web runtime stack: FastAPI backend plus React frontend.
+The old `web_ui/` Gradio implementation has been removed.
+
+## Recommended Startup
+
+### Start Backend And Frontend Together
+
+```bash
+python start_caddesigner_full.py
+```
+
+Default addresses:
+
+- React UI: `http://localhost:7860`
+- API server: `http://localhost:8000`
+- API docs: `http://localhost:8000/docs`
+
+### Start Backend Only
+
+```bash
+python start_caddesigner_api.py
+```
+
+### Start Frontend Only
+
+```bash
+python start_caddesigner_ui.py
+```
+
+This is useful when the API is already running locally or remotely. Use `--api-url` to switch the target API address.
+
+## Frontend Development Mode
+
+If you are developing `frontend/` itself, start the backend separately and then run Vite directly:
+
+```bash
+python start_caddesigner_api.py --reload
+cd frontend
+pnpm install
+pnpm dev
+```
+
+When Vite is run directly, the default address is `http://localhost:4173`.
+
+## Common Arguments
+
+`start_caddesigner_full.py`:
+
+- `--api-host` / `--api-port`: backend listen address
+- `--ui-host` / `--ui-port`: frontend listen address
+- `--working-dir`: API process working directory. Defaults to `./workspace`, so generated scripts, STEP/STL files, and render artifacts are kept out of the repository root.
+- `--reload`: auto-reload backend in development mode
+- `--debug`: print additional debugging information
+
+`start_caddesigner_api.py`:
+
+- `--host` / `--port`: backend listen address
+- `--working-dir`: API process working directory. Defaults to `./workspace`, so generated scripts, STEP/STL files, and render artifacts are kept out of the repository root.
+- `--reload`: auto-reload backend in development mode
+- `--workers`: number of worker processes when reload is disabled
+
+`start_caddesigner_ui.py`:
+
+- `--host` / `--port`: frontend listen address
+- `--api-url`: backend address used by the Vite proxy
+- `--debug`: print additional debugging information
+
+## Notes
+
+- `start_caddesigner_full.py` waits for the backend health check to pass before starting the React UI.
+- `start_caddesigner_ui.py` automatically installs frontend dependencies when `frontend/node_modules/` is missing.
+- The backend process still controls the business working directory and artifact paths. By default, runtime outputs are written under `workspace/` while the tracked skill references remain under `workspace/skills/`.