React + Vite

Documentation: See the unified Open AIQ documentation for dashboard usage, device guides, architecture, and API conventions. This README remains the source of truth for frontend setup.

Clerk authentication

Set VITE_CLERK_PUBLISHABLE_KEY and VITE_API_URL in the appropriate Vite environment file (see .env.example). In the Clerk Dashboard, enable Google, GitHub, and email/password sign-in; require email verification; enable password reset; and register the exact development and production frontend origins and redirect URLs. The matching origins must also be present in the backend's CLERK_AUTHORIZED_PARTIES.

Public map

The public landing page and community map use MapLibre GL JS with OpenFreeMap's keyless public Liberty style. No map account or API key is required. Set the optional VITE_MAP_STYLE_URL only when overriding the basemap with another MapLibre-compatible style. OpenFreeMap/OpenMapTiles/OpenStreetMap attribution is provided by the style and rendered by MapLibre.

Public routes live at /, /map, and /devices/:id; the Clerk-protected dashboard lives below /app. Firebase Hosting rewrites all routes to the Vite entrypoint.

Deployments and releases

Deploy the current checkout to Firebase Hosting with:

npm run deploy

This creates a production build before running firebase deploy --only hosting. It requires an authenticated Firebase CLI with access to the configured project.

Cut a release from a clean main branch with:

npm run release

The release script accepts a major, minor, or patch bump, or an exact semantic version; runs lint, tests, and a production build; updates package.json and package-lock.json with npm version; pushes the resulting version commit and tag; and publishes a GitHub release. It requires an authenticated gh CLI. To bypass the version prompt, use npm run release -- 1.4.0 (a leading v and prerelease suffix such as 1.4.0-rc.1 are also accepted). Deployment is intentionally a separate command.

This template provides a minimal setup to get React working in Vite with HMR and some Oxlint rules.

Currently, two official plugins are available:

• @vitejs/plugin-react uses Oxc
• @vitejs/plugin-react-swc uses SWC

React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see this documentation.

Expanding the Oxlint configuration

If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the TS template for information on how to integrate TypeScript and Oxlint's TypeScript related rules in your project.