Skip to content

docs: clarify which dev server actually serves the app #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vishu-bh merged 1 commit into from
Aug 21, 2026
Merged

docs: clarify which dev server actually serves the app #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 25 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Loading