How onivue/onivue-resume works
Main System Components
a) Client-Side Layer:
• Main UI components (found in the /components directory)
• Components logically:
• Template Components (Zen template)
• Form Components (DocForm, SettingsForm)
• Common UI Components (Button, Modal, ColorPicker, etc.)
• PDF Generation Components (PDFViewer)
b) Application Layer:
• This in the middle
• Next.js pages structure (/pages directory)
• API routes (/pages/api)
• State management (Zustand store in /stores)
c) Utility Layer:
• This at the bottom
• Custom hooks (/hooks directory)
• Helper functions (/lib directory)
Component Relationships
• Double lines: Two-way interactions
Specific Implementation Details
• React Hook Form integration
• Tailwind CSS styling system
• PDF generation system
• Dark mode implementation
• Block-based document system
Data Flow Visualization
Flow of data:
• Form data → State management → PDF generation
• User interactions → Form updates → Live preview
• Settings changes → Template rendering
Important Elements
• Custom hooks (useClickOutside, useElementSize, etc.)
• State management store (useResumeStore)
• Form handling components
• Template system architecture
Architecture Patterns
Following patterns:
• Component composition pattern (shown in Forms structure)
• Hook-based state management
• Client-side rendering architecture
• Modular block system
Technical Stack Indicators
• Next.js
• React
• Tailwind CSS
• React Hook Form
• Headless UI
• The modular nature of the component system
• The separation between template logic and form handling
• The PDF generation pipeline
• State management flow
• The block-based document system
Keep the abstraction level focused on the architectural decisions while showing enough detail to understand the component relationships and data flow. This will help developers understand both the high-level structure and the specific implementation details of the resume builder application.
Remember to indicate that this is a client-side heavy application with PDF generation capabilities, which is a crucial architectural characteristic of this project.