diff --git a/README.md b/README.md index a88acb1..0142f9f 100644 --- a/README.md +++ b/README.md @@ -359,25 +359,31 @@ contextforge-web-ui/ ## Available Scripts -| Script | Description | -| ----------------------- | ---------------------------------------- | -| `npm run dev` | Start development server | -| `npm run build` | Build for production | -| `npm run generate` | Regenerate API types from `openapi.json` | -| `npm run preview` | Preview production build | -| `npm run lint` | Check for linting errors | -| `npm run lint:fix` | Auto-fix linting errors | -| `npm run format` | Format all files with Prettier | -| `npm run format:check` | Check formatting without changes | -| `npm run test` | Run tests in watch mode | -| `npm run test:run` | Run tests once (CI mode) | -| `npm run test:ui` | Run tests with UI | -| `npm run test:coverage` | Generate coverage report | -| `npm run e2e` | Run Playwright E2E tests | -| `npm run e2e:ui` | Playwright UI mode | -| `npm run e2e:debug` | Playwright Inspector | -| `npm run e2e:install` | Install Playwright browsers | -| `npm run e2e:report` | Open last Playwright report | +Run from the repo root unless noted. The app you actually visit is the BFF +on `:3000` — see [Getting Started](#getting-started) for the full three-process +setup. + +| Script | Description | +| ---------------------------- | ----------------------------------------------------------------------------------- | +| `npm run dev` (in `server/`) | **Start the BFF (`:3000`)** — serves the SPA and proxies `/api/*` to the API | +| `npm run dev` | Vite dev server (`:5173`), UI-only — no BFF in front, so `/api/*` calls won't work | +| `npm run build` | Build the SPA into `server/public/`, which the BFF serves (also the local dev loop) | +| `npm run build:watch` | Rebuild on change — the iteration loop when running against the real API | +| `npm run generate` | Regenerate API types from `openapi.json` | +| `npm run preview` | Preview production build | +| `npm run lint` | Check for linting errors | +| `npm run lint:fix` | Auto-fix linting errors | +| `npm run format` | Format all files with Prettier | +| `npm run format:check` | Check formatting without changes | +| `npm run test` | Run tests in watch mode | +| `npm run test:run` | Run tests once (CI mode) | +| `npm run test:ui` | Run tests with UI | +| `npm run test:coverage` | Generate coverage report | +| `npm run e2e` | Run Playwright E2E tests | +| `npm run e2e:ui` | Playwright UI mode | +| `npm run e2e:debug` | Playwright Inspector | +| `npm run e2e:install` | Install Playwright browsers | +| `npm run e2e:report` | Open last Playwright report | ## Internationalization (i18n)