Document clean setup and runtime prerequisites

This commit is contained in:
2026-07-18 10:19:14 +08:00
parent 790a84508f
commit d6413700cc
2 changed files with 35 additions and 7 deletions
+34 -7
View File
@@ -22,6 +22,32 @@ This first rebuild focuses on SolidWorks feature-process learning:
5. Compare feature method and core parameters.
6. Start a testing session and produce a grade report.
## Prerequisites
- Windows with SolidWorks installed for CAD integration.
- .NET SDK 10.0.
- Python 3.13 or a compatible Python 3 version.
- Node.js 24 and npm, or a compatible current LTS release.
## First-Time Setup
Create the local machine-path configuration:
```powershell
Copy-Item project_paths.example.json project_paths.json
```
Set `solidworks_exe` in `project_paths.json` to the local `SLDWORKS.exe`.
For this workstation the value is:
```text
C:\Programs\SOLIDWORKS Corp\SOLIDWORKS\SLDWORKS.exe
```
`project_paths.json` remains local and is ignored by Git. The shared AI
service configuration is stored in the tracked
`backend-csharp/Agent4.Api/appsettings.Local.json` file.
## Run Backend
```powershell
@@ -35,13 +61,14 @@ Backend URL:
http://127.0.0.1:7200
```
## Local Configuration
Start the frontend in a second PowerShell window:
Copy `.env.example` to `.env` and fill in only the paths available on the
current machine. Keep `project_paths.json`, `appsettings.Local.json`, and
`.env` local; they are intentionally ignored by Git. Large CAD/knowledge
assets are also distributed separately and are not required for a source
checkout.
```powershell
.\run_frontend.ps1
```
Large CAD and knowledge-base assets are distributed separately and are not
required to build or start the base application.
The default backend is now the C# API:
@@ -59,7 +86,7 @@ The earlier Python FastAPI backend remains as a fallback/reference and can be st
```text
GET /health
GET /api/standards?query=榻胯疆
GET /api/standards?query=齿轮
GET /api/standards/{standard_id}
POST /api/teaching/sessions
POST /api/teaching/sessions/{session_id}/observations