How vivekverma807/resumecraft works
Project type and purpose
• From the file tree and README, this is a client-side, single-page/static web application called “Resume Builder.”
• It provides a login page, a resume-building interface, and PDF export functionality, all implemented in plain HTML/CSS/JavaScript without a dedicated backend server.
File structure
Top-level:
• index.html (landing page)
• auth/login.html (login UI)
• builder.html (resume-builder UI)
assets/:
• resume-template.docx (source template)
scripts/:
• auth.js (login logic)
• main.js (shared initializers/routing)
• builder.js (resume editor logic)
• pdf-export.js (PDF generation)
• storage.js (localStorage persistence)
styles/:
• style.css (global styles)
• builder.css (builder-page styles)
README for additional insights
• The README only gives the project title. No further architectural notes are provided, so we infer architecture solely from file structure and naming.
a. Main components
• User Interface
– Login Page (auth/login.html + auth.js + style.css)
– Builder Page (builder.html + builder.js + builder.css)
– Landing/Index (index.html + main.js + style.css)
• Client-side Services
– Authentication Service (auth.js)
– State Persistence (storage.js → localStorage)
– PDF Export Engine (pdf-export.js)
• Assets Store
– Resume Template (assets/resume-template.docx)
b. Relationships & interactions
1. User visits index.html → main.js routes to login or builder.
2. On login.html, auth.js validates credentials (e.g., mock or third-party API if implemented).
3. auth.js → upon success, redirect to builder.html.
4. In builder.html, builder.js loads any saved data via storage.js.
5. User edits fields → builder.js updates UI and calls storage.js to persist draft.
6. When user clicks “Export to PDF,” builder.js invokes pdf-export.js, which transforms HTML/CSS and the resume template into a downloadable PDF.
7. Download link is provided to the user.
c. Architectural patterns & principles
• Modular front-end: separate JS modules for auth, storage, builder, export.
• Client-only state persistence: storage.js abstracts away localStorage operations.
• Feature separation by page (login vs. builder) rather than a single huge bundle.
d. Key technologies & libraries
• Vanilla JavaScript modules
• HTML5 + CSS3
• localStorage (via storage.js)
• PDF generation library or browser API (pdf-export.js may wrap jsPDF, html2pdf, etc.)
Elements
– UI Pages: Login Page, Builder Page, Index/Landing Page
– JS Modules: auth.js, storage.js, builder.js, pdf-export.js, main.js
– Assets: resume-template.docx
– User input → auth.js → redirect
– builder.js ↔ storage.js (read/write)
– builder.js → pdf-export.js → Download
– UI components (e.g., blue rectangles)
– Services/modules (e.g., green rectangles)