Remodel/packages/web/README.md

32 lines
737 B
Markdown

# remodel-web
Next.js App Router frontend for REmodel.
## Setup
```bash
pnpm install
```
## Common commands
```bash
pnpm dev # dev server on :3000
pnpm build # production build
pnpm lint # eslint
pnpm type-check # tsc --noEmit
pnpm generate-types # regenerate API types from OpenAPI (needs API on :8000)
```
## Adding shadcn/ui components
```bash
pnpm dlx shadcn@latest add <component-name>
```
## Key conventions
- All API types live in `app/api-types/index.ts` (auto-generated). Never hand-write them.
- `DataGrid` wrapper (AG Grid Community) lives in `components/DataGrid/` — one implementation only.
- Server state: TanStack Query. Client-only UI state: Zustand.
- Charts: Recharts only.