Name	Name	Last commit message	Last commit date
parent directory ..
client	client
server	server
README.md	README.md

Name

Last commit message

Last commit date

Setup Instructions

Prerequisites

Install Python 3.11 or newer — required for the server runtime.
Install Node.js 22 or newer with npm — required for the client build tooling.
Install Git and make sure pip and npm are on your PATH — needed for dependency management.

cd web_control/server — switch to the server workspace.
python -m venv .venv — create an isolated Python environment.
source .venv/bin/activate (Linux/macOS) or .venv\Scripts\activate (Windows) — activate the environment.
pip install -r requirements.txt — install server dependencies.
cp .env.example .env — create the server environment file.
Edit .env and set at minimum:
- UI_HOST=0.0.0.0 — choose the bind address.
- UI_PORT=8000 — choose the HTTP port.
- ROBOT_HOST=localhost — point to the robot or simulator host.
- ROBOT_PORT_CMD=5555 and ROBOT_PORT_DATA=5556 — configure ZeroMQ ports.
python main.py — start the FastAPI and Socket.IO server.

cd web_control/client — switch to the client workspace.
npm install — install client dependencies.
cp .env.example .env (create if absent) — define client environment variables.
Edit .env and set at minimum:
- VITE_SERVER_PROTOCOL=http — protocol used to reach the server.
- VITE_SERVER_HOST=localhost — hostname or IP of the server.
- VITE_SERVER_PORT=8000 — port that matches the server.
npm run dev — launch the Vite dev server.
npm run build — produce a production build when needed.

Ensure the server is running and reachable — required before opening the UI.
Ensure the client dev server or production build is served — needed for browser access.
Open http://localhost:5173 (default dev URL) — verify the dashboard loads.
Monitor terminal logs for telemetry, errors, or reconnect issues — helps with troubleshooting.