Initial commit

Kenteken-Gen-1-main/docs/README.md

@@ -0,0 +1,36 @@
+# Kenteken-Gen-1
+Kenteken Gen 1
+
+## Frontend
+A small React frontend lives in `src/frontend` and is powered by [Vite](https://vitejs.dev/).
+
+Exported license plate images are generated at 180 DPI. This matches the
+resolution used in our Photoshop documents, so the centimeter values entered in
+the app correspond to the real-world dimensions when those images are opened or
+pasted there.
+
+### Running the frontend
+1. Install dependencies:
+   ```sh
+   npm install
+   ```
+2. Start the development server:
+   ```sh
+   npm run dev
+   ```
+   Visit http://localhost:5173/ to view the app.
+3. Create a production build:
+   ```sh
+   npm run build
+   ```
+
+### Kinderauto toevoegen
+
+In de frontend kan een gebruiker een eigen *Kinderauto* toevoegen. Hierbij worden
+de afmetingen van het kenteken voor ingevoerd en optioneel andere maten voor
+achter. De opgegeven opties worden in `localStorage` bewaard zodat ze bij een
+volgende sessie weer beschikbaar zijn.
+
+Als er voor een kinderauto ook achterafmetingen zijn opgegeven, toont de app
+automatisch twee kentekens: één voor en één achter. Zonder achterafmetingen wordt
+er slechts één kenteken gegenereerd.