diff --git a/README.md b/README.md index 9c3fbe7..5104a14 100644 --- a/README.md +++ b/README.md @@ -50,3 +50,24 @@ This app provides a lightweight local interface to manage Kubernetes clusters vi - Keep frontend vanilla JS or minimal framework to stay lightweight - Consider running kubectl via subprocess with proper input validation - Add a simple status indicator for kubectl connectivity + +## Running Locally + +To test the app locally: + +1. Start the backend: + ```bash + cd backend + pip install -r requirements.txt + uvicorn main:app --reload --host 0.0.0.0 --port 8000 + ``` + +2. Serve the frontend (from the repo root or frontend folder): + ```bash + cd frontend + python -m http.server 8080 + ``` + +3. Open `http://localhost:8080` in your browser. The frontend connects to `http://localhost:8000` (CORS is enabled in the backend). + +Make sure `kubectl` is installed and configured with access to your cluster.