How framerrr/framerr works
Framerr is a self-hosted homelab dashboard. Users authenticate, configure integrations and dashboards, then view embedded tabs and live widgets; administrators can also share layouts, manage notifications, and customize the experience. The browser app communicates through a centralized API client with an Express server, whose routes use database-backed services. Realtime updates use SSE, while integration adapters connect the product to homelab services. The graph reflects README capabilities and the supplied source index/excerpts; several feature implementations were not sampled, so undocumented connections are omitted.
Main entry points: routes HTTP route handlers · App.tsx React application · integrations Integration adapters · client.ts API client
Components 17
User experience
- React application
src/App.tsx - Authentication
src/context/AuthContext.tsx - Themes and settings
src/settings/customization
Application platform
- API client
src/api/client.ts - Express application
server/app.ts - HTTP route handlers
server/routes - SQLite persistence
server/database/db.ts
Dashboard capabilities
- Dashboards and widgets
src/app/dashboard - Iframe tabs
src/app/tabs - Notifications and push
server/routes/notifications.ts - Dashboard templates
server/routes/templates - User and resource sharing
server/routes/widgetShares.ts
Service operations
- Integration adapters
server/integrations - Integration polling
server/services/servicePoller.ts - SSE delivery
server/services/sse
Other components
- Dashboard user
- Homelab services
Connections 18
- Dashboard user → React application: uses
README.md - React application → Authentication: provides auth
src/App.tsx - React application → Dashboards and widgets: renders
src/App.tsx - React application → Iframe tabs: renders
README.md - React application → Themes and settings: offers settings
README.md - Dashboards and widgets → API client: requests data
- Themes and settings → API client: saves settings
- API client → Express application: sends requests
- Express application → HTTP route handlers: registers routes
server/app.ts - HTTP route handlers → SQLite persistence: persists data
- HTTP route handlers → Integration adapters: proxies service requests
- Homelab services → Integration adapters: serves integration data
README.md - Integration polling → Integration adapters: polls services
- Integration adapters → SSE delivery: supplies live updates
- SSE delivery → React application: streams updates
- HTTP route handlers → Notifications and push: handles alerts
- HTTP route handlers → Dashboard templates: handles layouts
- HTTP route handlers → User and resource sharing: handles access