Skip to content

Frontend

The Voltimax frontend consists of a Vue.js web application and a TypeScript API client library, both located under src/@voltimax/.

Projects

IoT Frontend

@voltimax/iot-frontend is the main web application for the Voltimax IoT Platform.

FrameworkVue 3 with TypeScript
Build toolVite
Type checkingvue-tsc
LintingESLint
TestingVitest (unit), with UI and coverage support
Component storiesHistoire

Scripts

bash
# Development
pnpm dev              # Start Vite dev server
pnpm build            # Type-check and build for production
pnpm preview          # Preview production build

# Testing
pnpm test             # Run tests once
pnpm test:watch       # Run tests in watch mode
pnpm test:ui          # Run tests with Vitest UI
pnpm test:coverage    # Run tests with coverage

# Linting
pnpm lint             # Check for lint errors
pnpm lint:fix         # Auto-fix lint errors

# Stories
pnpm story:dev        # Start Histoire dev server

Platform Client JS

@voltimax/platform-client-js is the official TypeScript/JavaScript client library for the Platform API.

It provides typed exports for:

ExportDescription
@voltimax/platform-client-js/clientHTTP client for API communication
@voltimax/platform-client-js/typesTypeScript type definitions
@voltimax/platform-client-js/sdkHigh-level SDK wrapper
@voltimax/platform-client-js/coladaPinia Colada integration for Vue

Authentication

The frontend authenticates against Keycloak using the iot-frontend OIDC client with PKCE (S256). See the Migration Service documentation for client configuration details.