Skip to content

ombr-gh/client

Repository files navigation

Ombr Client

CodeQL Advanced

Frontend web client for Ombr, built with React, TypeScript, and Vite.

Prerequisites

  • Node.js 20+
  • npm 10+

Getting Started

npm install

Run in Development

npm run dev

Build for Production

npm run build

Preview Production Build

npm run preview

Lint

npm run lint

Project Structure

  • src/: App source code (components, styling, entry points)
  • public/: Static assets and web manifest
  • index.html: App HTML template
  • vite.config.ts: Vite config
  • tsconfig*.json: TypeScript config
  • eslint.config.js: ESLint config

API Client

The client exposes a typed API wrapper in src/lib/api, backed by shared types and utilities in common/.

  • Use api.auth.login(...), api.auth.register(...), and api.auth.logout() for session flows.
  • Use api.users.*, api.devices.*, api.punishments.*, api.staff.*, and api.market.purchase(...) for higher-level app actions.
  • Set VITE_API_BASE_URL if the HTTP server is not reachable through the default /api path.

About

Client site for account management, device registration, and data viewing.

Resources

License

Stars

Watchers

Forks

Contributors

Languages