How sbsawane/resumeaipro works
Project Type and Purpose
• This is a single-page front-end application (SPA) built with React, TypeScript, Vite, and Tailwind CSS.
• From the component names and utils, it’s a resume-building and ATS (Applicant Tracking System) analysis tool (“ResumeAiPro”) that allows users to input job descriptions, upload or build resumes, run ATS keyword analysis, preview the formatted resume, and export it (e.g., as PDF).
Top-Level File–Structure Analysis
• Configuration & Build:
• package.json / package-lock.json – npm dependencies
• vite.config.ts – build/hot-reload setup
• tsconfig*.json, eslint.config.js, postcss.config.js, tailwind.config.js – TypeScript, linting, CSS toolchain
• Public Entry:
• index.html – SPA host page
• Source Code (src/):
• main.tsx & App.tsx – React entrypoint & root component
• components/ – UI panels (ATSAnalysisPanel, ExportPanel, JobDescriptionInput, ResumeForm, ResumePreview)
• utils/ – pure functions for ATS analysis (atsAnalyzer.ts) and export (exportUtils.ts)
• types/ – TypeScript definitions (resume.ts)
Key Roles & Interactions
• Browser (Client) loads the bundled SPA via index.html → main.tsx → App.tsx.
• App.tsx manages application state (job description text, resume data, analysis results).
• JobDescriptionInput component captures JD text → passes to atsAnalyzer util → produces keyword analysis.
• ResumeForm component captures resume fields or file upload → validated against types/resume.ts.
• ResumePreview renders a live view of the resume based on state.
• ATSAnalysisPanel displays keyword‐matching insights.
• ExportPanel invokes exportUtils to generate an export format (PDF/Download).
1. User → JobDescriptionInput / ResumeForm
2. Component state updates in App.tsx
3. State → atsAnalyzer (utils) → analysis results
4. State → ResumePreview for live rendering
5. State & types → exportUtils → download/ PDF
6. (Optional) atkAnalyzer ↔ External API
Architectural Patterns & Principles
• Component-based UI (React)
• Unidirectional data flow (lifting state to App.tsx)
• Separation of concerns: UI vs. pure logic (utils) vs. types
• Static site deployment (no backend in repo)