Welcome to the documentation for OpenFrame OSS Frontend, the primary web application powering the OpenFrame platform — a unified, AI-driven interface for Managed Service Providers (MSPs).
New to the project? Start here:
- Introduction — What is OpenFrame OSS Frontend and who it's for
- Prerequisites — Required software, system requirements, and environment variables
- Quick Start — Get the app running locally in under 5 minutes
- First Steps — Explore the app, verify your setup, and understand key directories
Guides for contributors and developers working in the codebase:
- Development Overview — Common commands, key directories, and technology choices
- Environment Setup — IDE configuration, editor extensions, recommended tools
- Local Development — Cloning, running locally, hot reload, debugging
- Architecture Overview — High-level system design, data flow patterns, state management
- Security Overview — Authentication patterns, input validation, secrets management
- Testing Overview — Test structure, running checks, writing testable code
- Contributing Guidelines — Code style, PR process, commit format, review checklist
Technical reference documentation generated from source code analysis:
- OpenFrame OSS Frontend — Main application architecture, feature domains, design principles
- Frontend Core — Shared UI component library and design system
- Frontend Core — Auth Context — Authentication context providers
- Frontend Core — Chat Components — AI chat UI framework
- Frontend Core — Chat Types — Chat domain type definitions
- Frontend Core — Chat Utils — Chat utilities and helpers
- Frontend Core — Docs Components — Embeddable documentation surfaces
- Frontend Core — Embeds Components — Embed and iframe components
- Frontend Core — Features Components — AI enrichment and board systems
- Frontend Core — Hooks — Shared React hooks
- Frontend Core — Icons Components — Icon system
- Frontend Core — Layout Components — Page structure and chrome
- Frontend Core — Navigation Components — Header, sidebar, and mobile nav
- Frontend Core — Platform Components — Script, shell, and OS UI
- Frontend Core — Schemas — Zod runtime validation schemas
- Frontend Core — Shared Components — Roadmap, releases, onboarding, delivery
- Frontend Core — Tickets Components — Ticketing UI system
- Frontend Core — Types — Domain type definitions and contracts
- Frontend Core — UI Components — Design system primitives
- Frontend Core — Utils — Registries and configuration utilities
- Frontend Core — Vendor Components — Vendor identity layer
- Feature Flags — Frontend feature flag system
- React Embedding Example — How to embed OpenFrame in React apps
- API Service Core — Primary GraphQL API service
- API Service — API service implementation
- API Lib Service — Shared API service libraries
- API Lib DTO — Data transfer object definitions
- API Client — HTTP client abstractions
- External API Service Core — External integrations API layer
- Gateway Service Core — API gateway and routing
- Authorization Service Core — OAuth 2.0 / OIDC authorization
- Management Service Core — Tenant and management operations
- Stream Service Core — Event streaming (Kafka / NATS)
- Ticket Service — Ticketing backend service
- Client Core — Client-side shared core
- Core — Foundational shared module
- Config Core — Configuration management
- Security Core — Core security patterns and authentication
- Security OAuth — OAuth 2.0 implementation
- IDP Configuration — Identity provider setup
- Notification Push — Push notification service
- Notification Mail — Email notification service
- Data Mongo Common — Shared MongoDB utilities
- Data Mongo Reactive — Reactive MongoDB integration
- Data Mongo Sync — Synchronous MongoDB integration
- Data Cassandra — Apache Cassandra integration
- Data Pinot — Apache Pinot analytics integration
- Data Redis — Redis caching integration
- Data Kafka — Apache Kafka messaging integration
- Data NATS — NATS messaging integration
- Data Device Aspect — Device data modeling
- Data Time Entry Aspect — Time entry data modeling
- SDK Fleet MDM — Fleet MDM SDK integration
- Tool Agent NATS Installation — NATS-based tool agent installation
- Pinot Initializer — Apache Pinot schema initialization
- Debezium Initializer — Debezium CDC initialization
Visual architecture diagrams are available in the docs/diagrams/architecture/ directory. Each module has one or more Mermaid diagram files (.mmd) covering different aspects of its architecture.
Key diagram sets:
openframe-oss-frontend.mmd— Main application architecturefrontend-core.mmd— Shared UI library structuregateway-service-core.mmd— Gateway routing and proxystream-service-core.mmd— Event streaming topologyapi-service-core.mmd— API service internalsauthorization-service-core.mmd— Auth and OAuth flowssecurity-core.mmd/security-oauth.mmd— Security patterns
View all diagrams in docs/diagrams/architecture/.
- Project README — Main project overview and quick start
- Contributing Guidelines — How to contribute
- OpenFrame Website — Platform home
- Flamingo Platform — Built by Flamingo
- OpenMSP Slack Community — Primary support channel
- GitHub Repository — Source code
Documentation generated by 🦩 Flamingo AI Technical Writer