How meetfranz/franz works
Main Components
a. Frontend Layer:
• React-based UI components (src/components)
• Features modules (src/features)
• Stores for state management (src/stores)
• Theme system (packages/theme)
• Form components (packages/forms)
• UI components (packages/ui)
b. Electron Layer:
• Main Process (src/electron)
• IPC API handlers (src/electron/ipc-api)
• Browser View Manager
• Window Management
c. Service Integration Layer:
• Recipe System (for service integration)
• Service Handlers
• Webview Components
• Service Cache
d. Core Features:
• Authentication System
• Workspace Management
• Spellchecker
• Desktop Notifications
• Multi-language Support (i18n)
[User Interface Layer]
• ↑↓
[Feature Modules Layer]
• ↑↓
[Store/State Management Layer]
• ↑↓
[Electron Bridge Layer]
• ↑↓
[System Integration Layer]
Component Relationships
• Blue: Core application components
• Green: Service integration components
• Orange: Feature modules
• Purple: System integration
Key Elements to Highlight
a. Process Communication:
• Main Process ↔ Renderer Process communication
• IPC channels
• Service WebViews
b. Data Flow:
• User interactions
• Service message handling
• State updates
• Configuration management
Implementation Details
[UI Components] → [Feature Modules] → [Stores]
• ↑ ↑ ↑
[Electron IPC] ← [Main Process] → [Service Integration]
• ↑ ↑
[System APIs] ← -------------------- [Services]
Additional Elements
• Annotations for key architectural decisions
• Configuration flow
• Third-party service connections
Technical Stack Indicators
Technology badges or labels for:
• Electron
• React
• MobX (for stores)
• TypeScript (for typed components)
• WebView components
• Native OS integration points
Remember to highlight the extensibility points where new services can be integrated through the recipe system, as this is a key feature of Franz.