Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/juanmatz/inspection-form-euroautos/llms.txt

Use this file to discover all available pages before exploring further.

This page covers everything you need to get the Euroautos Inspection Form installed and configured on your machine — from minimum system requirements through environment variable reference. Whether you are setting up a local development environment or preparing a production build for deployment to a workshop kiosk or server, start here.

System Requirements

Before installing, confirm your environment meets the following minimums:
RequirementMinimum version
Node.js18.0.0
npm9.0.0
yarn (alternative)1.22.0
pnpm (alternative)8.0.0
Chrome90
Firefox88
Edge90
RAM512 MB
Internet Explorer and legacy Edge (EdgeHTML) are not supported. The application relies on IndexedDB, the File System Access API, and modern CSS features that are unavailable in those browsers.
You can verify your Node.js and npm versions with:
node --version
npm --version

Installation

Clone the repository from GitHub and install dependencies:
git clone https://github.com/juanmatz/inspection-form-euroautos.git
cd inspection-form-euroautos
Then install project dependencies with your preferred package manager:
npm install
Once installation finishes, a node_modules/ directory will be present in the project root.

Environment Variables

The application is configured through environment variables loaded by Vite at build / dev-server start time. Copy the provided template to get started:
cp .env.example .env
All supported variables are documented below.
VITE_WORKSHOP_NAME
string
required
The display name of the workshop. This value appears in the header of every generated PDF inspection report and on the application dashboard. Use your official workshop trading name.
VITE_WORKSHOP_NAME="Euroautos Workshop Madrid"
VITE_API_URL
string
The base URL of the optional backend REST API used for cross-device synchronisation of inspection records. When left blank or omitted, the application operates in fully local mode — all data remains in the browser’s local storage and no network requests are made.
VITE_API_URL=https://api.euroautos.example.com/v1
VITE_STORAGE_TYPE
string
default:"indexeddb"
The browser storage strategy to use for persisting inspection records and photo data. Accepted values:
  • indexeddb (default) — Uses IndexedDB, which supports larger storage quotas and is recommended for production use. Handles embedded photos comfortably.
  • local — Uses the Web Storage API (localStorage). Simpler to inspect via DevTools but limited to ~5 MB per origin; not suitable for inspections with many photos.
VITE_STORAGE_TYPE=indexeddb
VITE_MAX_PHOTO_SIZE_MB
number
default:"5"
The maximum allowed size (in megabytes) for a single photo attachment before the application rejects it with a validation error. Increasing this value allows higher-resolution photos to be attached but increases storage usage and PDF file sizes.
VITE_MAX_PHOTO_SIZE_MB=5

All variables must be prefixed with VITE_ to be accessible in the browser bundle. Variables without this prefix are available only in Vite config and server-side build scripts — they will not appear in the running application.

Verifying Installation

Start the Vite development server:
npm run dev
A healthy startup produces output like the following in your terminal:
  VITE v5.x.x  ready in 298 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h + enter to show help
Open http://localhost:5173 in your browser. You should see the Euroautos Inspection Form dashboard with:
  • The workshop name you set in VITE_WORKSHOP_NAME displayed in the top navigation bar.
  • An empty inspections list with a Nueva Inspección call-to-action button.
  • A status indicator in the footer showing storage type and (if configured) backend sync status.
If the page loads but the workshop name shows a fallback value such as “Workshop”, double-check that your .env file is in the project root (the same directory as vite.config.ts) and that the VITE_WORKSHOP_NAME variable is correctly quoted.
To build a production-optimised bundle:
npm run build
The compiled static assets are written to dist/. Serve this directory with any static file host (Nginx, Apache, Vercel, Netlify, etc.).

Next Steps

With installation complete, proceed to:
  • Quickstart — create your first digital inspection end-to-end
  • Inspection Sections — learn how to customise the checklist sections displayed in the form

Build docs developers (and LLMs) love