Manual
Comprehensive reference documentation for the INVENT platform.
Documentation Sections
Guidelines
Widget development patterns, best practices, and technical specifications:
- Guidelines Overview - Widget development fundamentals
- Widget Development - Development overview
- Widget Publishing - Publishing flow
- Work with Widgets - Technical details
- Widget Config - Configuration reference
- API Guidelines - API integration
- Platform Widgets - Platform-level widgets
- Structure Widget Template - Repository structure
Backend for Frontend (BfF)
Customization backend documentation:
- BFF Overview - BfF pattern and architecture
- BFF Core - Implementation details
- BFF Specification - API endpoints
Extensions
Platform extension system:
- Extensions - Extension architecture
- BFF-WS-EXT - WebSocket extension
- Preset Extension - Widget presets
UI-Kit
Shared component library:
- UI-Kit - Component library overview
- UI-Kit Testing - Testing guidelines
- Proxy Widgets - OAuth components
Theming
Platform theming system:
- Theme Serving - Theme structure
- Theme Using - Using themes in widgets
Widget Store
Widget distribution and storage:
- Widget Store - Overview
- Widget Store API - REST endpoints
- Widget Store Local Start - Local development
- Widget Store Migrations - Data structure
Wlabel (Host Application)
Host application documentation:
- Wlabel - White labeling overview
- Wlabel API - Complete API reference
Technology
Platform technologies and patterns:
- Module Federation - Widget loading architecture
- Packages (Versioning) - NPM package versioning
Release Process
Deployment and versioning:
- Semantic Release - Automated versioning
Installation & Setup
BfF installation guides:
- Installation (macOS) - BfF setup for macOS
- Installation (Ubuntu) - BfF setup for Ubuntu
- Installation (Windows) - BfF setup for Windows
Reference
Technical reference documentation:
- Environment Variables - Runtime variables
- BrowserStack - Cross-browser testing
- PR Decoration - Pull request standards
Quality & Standards
Code quality and standards:
- Code Style - Linting, formatting, hooks
- Versioning - Semantic versioning
- A11y Support - Accessibility guidelines
Onboarding
Team onboarding resources:
- FE Onboarding - Complete onboarding checklist
Quick Navigation
For Widget Developers
- Start with Guidelines
- Configure with Widget Config
- Integrate APIs with API Guidelines
- Style with Theming
For Platform Developers
- Understand BFF
- Review Extensions
- Study Module Federation
For System Administrators
- Configure Environment Variables
- Setup BfF Installation
- Manage Widget Store
Return to: Documentation Home