How biugle/biu works
biu is a modular frontend foundation for enterprise Portals, independently deployed APPs, and React Custom projects. The primary workflow is: a developer uses the CLI to scaffold or discover a project, resolve menu and route inputs, and generate a page registry; the Runtime then provides navigation, authentication, preferences, and remote-APP hosting, while Presets supply Portal layouts. Shared packages provide routing, state, UI, localization, and communication contracts. Major documented capabilities are included even where implementation excerpts were unavailable; those links are based on the README rather than sampled source.
Main entry points: index.tsx Runtime Core · project.ts Project Discovery · layout-frame.tsx Portal Layout · cli.ts CLI Commands
Components 23
Project CLI
- CLI Commands
packages/cli/src/cli.ts - Project Discovery
packages/cli/src/project.ts - Foundation Snapshot
packages/cli/src/foundation.ts
App Runtime
- Runtime Core
packages/runtime/src/index.tsx - Runtime Context
packages/runtime/src/context.tsx - Remote APP Hosting
packages/runtime/src/remote.tsx - Authentication Gate
packages/runtime/src/auth-page.tsx - Build Update Check
packages/runtime/src/update-check.ts
Portal Shell
- Layout Presets
packages/preset/src/core.tsx - Portal Layout
packages/preset/src/layout-frame.tsx - React Adapter
packages/adapter-react/src/index.tsx
Shared Contracts
- Menu And Router
packages/router/src/navigation.ts - Window Bridge
packages/bridge/src/index.ts - Event Bus
packages/events/src/index.ts - Localization
packages/i18n/src/index.ts
State And UI
- Scoped Stores
packages/store/src/index.ts - Tab Sessions
packages/store/src/store/session-store.ts - Shared UI
packages/ui/src/index.ts
Other components
- Developer
- Portal Or APP
- Remote APP
- Menu And Permission API
- SSO Provider
Connections 28
- Developer → CLI Commands: runs commands
- CLI Commands → Project Discovery: discovers project
- Project Discovery → Portal Or APP: reads configuration
- Project Discovery → Menu And Permission API: requests menus
- Project Discovery → Menu And Router: uses route rules
- CLI Commands → Foundation Snapshot: prepares packages
- Project Discovery → Runtime Core: generates entry
- Developer → Runtime Core: opens app
- Runtime Core → Runtime Context: provides context
- Runtime Core → Menu And Router: resolves navigation
- Runtime Core → Scoped Stores: manages app state
- Runtime Core → Remote APP Hosting: hosts remote apps
- Remote APP Hosting → Remote APP: loads remote app
- Remote APP Hosting → Window Bridge: exchanges messages
- Runtime Context → Window Bridge: posts overlay state
- Runtime Core → Authentication Gate: gates access
- Authentication Gate → SSO Provider: requests authentication
- Runtime Core → Build Update Check: checks build
- Layout Presets → Portal Layout: composes shell
- Portal Layout → Runtime Context: uses runtime context
- Portal Layout → Menu And Router: uses menu paths
- Portal Layout → Scoped Stores: reads menu state
- Portal Layout → Shared UI: uses overlays
- React Adapter → Runtime Core: adapts React
- Runtime Core → Localization: uses translations
- Runtime Core → Event Bus: exposes events
- Runtime Core → Tab Sessions: persists tab session
- Shared UI → Developer: provides interactions