diff --git a/frontend/README.md b/frontend/README.md index 4028da5..5544437 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -30,14 +30,28 @@ VITE_API_BASE_URL=/api/v1 npm install ``` -After the package is installed, verify both backend entry points from the same activated Python environment: +3. **Install the OpenSpace Python package** from the repo root into the same Python environment that will run the backend: + +```bash +cd .. +python -m pip install -e . +``` + +4. **Verify both backend entry points** from that same activated Python environment: ```bash openspace-mcp --help openspace-dashboard --help ``` -3. **Start the backend** (in a separate terminal) +If the console scripts are still unavailable on `PATH`, verify the module entry points from the repo root instead: + +```bash +python -m openspace.mcp_server --help +python -m openspace.dashboard_server --help +``` + +5. **Start the backend** (in a separate terminal) ```bash # option A – CLI entry point @@ -51,9 +65,10 @@ python -m openspace.dashboard_server --host 127.0.0.1 --port 7788 > > If `openspace-dashboard` is not on `PATH`, use option B. On Windows, make sure the same virtual environment is activated before running either command. -4. **Start the frontend** +6. **Start the frontend** ```bash +cd frontend npm run dev ``` @@ -61,7 +76,7 @@ The dev server will be available at `http://127.0.0.1:3888` (or whatever `VITE_P ## Subsequent Starts -Once `.env` is configured and dependencies are installed, you only need: +Once `.env` is configured, frontend dependencies are installed, and the OpenSpace package is installed in your active Python environment, you only need: ```bash # terminal 1 – backend