How gianfrancodemarco/resume-builder works
Project type and purpose
• This is a modern single-page application (SPA) front-end only “Resume Builder” built with Vue 3, Vuetify 3 and TipTap.
• It runs entirely in the browser, offering a WYSIWYG editor, live preview, style customization, export to HTML/PDF/JSON, AI-based CV conversion, and local JSON import/export.
File structure
• Top-level files: index.html, package.json, Vue/Vite/Vitest configs, public assets → static SPA setup.
• src/
• src/main.js & src/router.js → app bootstrap & routing
• src/views/ → page‐level Vue components (LandingPage, EditorPage)
• src/components/EditorPage → reusable UI parts: ResumeEditor, ResumePreview, LateralMenu, dialogs, styles
• src/models → domain models (ResumeDataV1/V2, ResumeStyleV1)
• src/services → core business logic (ResumeService for state persistence, ExporterService for file exports, CVConversionService for AI conversion)
• src/assets → images/fonts, etc.
• src/test & __tests__ → automated unit tests
Readme insights
• Confirms front-end SPA with no backend; data never leaves the browser except when calling external AI APIs or downloading files.
• Features: dynamic sections, real-time preview, AI conversion via external AI models, export formats, mobile responsiveness.
Main components & interactions
a. Client Application (Browser)
• UI Layer (Vue views & components)
• Business Logic Layer (services)
• Data Layer (models + browser storage)
b. External Integrations
• AI Conversion API (e.g., OpenAI or similar)
• File System APIs (Browser download, PDF generator library)
c. Build & Deployment
• Dev: Vite dev server
• Prod: Static host (Netlify/GitHub Pages/CDN)
Architectural patterns & design principles
• Component-based organization (Vue’s declarative UI).
• MVVM-style separation:
• View (Vue components & Vuetify UI)
• ViewModel/Controller (services orchestrating data flow)
• Model (plain JS classes representing resume data/style)
• Single Responsibility: services encapsulate export, conversion, persistence.
• Dependency injection via module imports.
• Test coverage: unit tests co-located under __tests__.