30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
# AGENTS
|
||
|
||
This repository contains the Kenteken Generator desktop app built with Electron and React.
|
||
|
||
## Project layout
|
||
- `src/frontend` – React components and styles for the UI.
|
||
- `electron` – main Electron process and preload scripts.
|
||
- `src/kenteken_gen` – backend utilities (currently minimal).
|
||
- `docs` – extra documentation.
|
||
- `build` – packaging assets such as icons.
|
||
|
||
## Conventions
|
||
- React component files use **PascalCase** (`CarManager.jsx`).
|
||
- Functions and variables use **camelCase**.
|
||
- Keep functions small and add brief comments to explain non-obvious logic.
|
||
|
||
## Scripts
|
||
- `npm run dev` – start the Vite dev server.
|
||
- `npm run build` – build the frontend for production.
|
||
- `npm run start` – launch Electron with the built assets.
|
||
- `npm run dist` – build and package the app.
|
||
- `make lint` – run lint checks (placeholder).
|
||
- `make test` – run tests (placeholder).
|
||
|
||
## Tips
|
||
- License plate generation and rendering lives in `src/frontend/LicensePlateApp.jsx`.
|
||
- Car preset management is implemented in `src/frontend/CarManager.jsx`.
|
||
- IPC helpers are exposed via `electron/preload.cjs` and handled in `electron/main.js`.
|
||
- Use `rg` (ripgrep) to search the codebase, e.g. `rg saveCars`.
|