Skip to content

GoldLion123RP/resume-builder

Repository files navigation

πŸ“„ Resume Builder

A modern, ATS-friendly Resume Builder designed specifically for technical university students (B.Tech CS/IT/ECE/EE). Build professional resumes with beautiful templates, export to PDF/DOCX, and sync across devices - completely FREE!

Live Demo GitHub License


✨ Features

🎨 Core Features

  • βœ… 11 Customizable Sections - Profile, Education, Experience, Projects, Skills, Certifications, Achievements, POR, Publications, Extracurriculars, Languages
  • βœ… 6 Professional Templates - Classic, Modern, Minimal, Two-Column, Compact, ATS-Optimized
  • βœ… ATS-Friendly Mode - Toggle between beautiful and scanner-optimized formats
  • βœ… Live Preview - See changes in real-time
  • βœ… Sample Data Loader - Pre-filled examples (Bengali/Indian context)

πŸ’Ύ Storage & Sync

  • βœ… Works Offline - LocalStorage ensures data persists without login
  • βœ… Cloud Sync (Optional) - Firebase authentication for multi-device access
  • βœ… Auto-Save - Never lose your work (2-second debounce)
  • βœ… Export Formats - PDF (Beautiful & ATS), DOCX, Plain Text

πŸ” Authentication

  • βœ… Google Sign-In
  • βœ… GitHub Sign-In
  • βœ… Facebook Sign-In
  • βœ… Email/Password

🎨 Customization

  • βœ… Dark Mode - System preference + manual toggle (Light/Dark/Auto)
  • βœ… Custom Colors - Choose your accent color
  • βœ… Font Selection - 5 professional fonts
  • βœ… Spacing Control - Compact or spacious layouts

πŸ“š Guidance & Tips

  • βœ… Action Verbs Bank - 240+ power verbs in 12 categories
  • βœ… Resume Formulas - XYZ, STAR, PAR, CAR formats
  • βœ… Writing Tips - Best practices and common mistakes
  • βœ… Progress Tracker - See completion percentage with suggestions

πŸ“± User Experience

  • βœ… Mobile Responsive - Works perfectly on all devices
  • βœ… Keyboard Accessible - Full keyboard navigation support
  • βœ… Screen Reader Friendly - WCAG 2.1 AA compliant
  • βœ… Toast Notifications - Real-time feedback for user actions
  • βœ… Error Boundaries - Graceful error handling
  • βœ… Fast & Lightweight - Optimized performance with lazy loading

πŸš€ Quick Start

Try it Live

πŸ‘‰ Open Resume Builder πŸ‘ˆ

No installation needed! Works directly in your browser.


πŸ› οΈ Local Development

Prerequisites

  • Node.js >= 18.0.0
  • npm >= 9.0.0
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/GoldLion123RP/resume-builder.git
    cd resume-builder
  2. Install dependencies

    npm install
  3. Set up environment variables (Optional - for Firebase sync)

    # Copy the example file
    cp .env.example .env.local
    
    # Edit .env.local and add your Firebase credentials

    Get Firebase Credentials:

    • Go to Firebase Console
    • Create a new project
    • Enable Authentication (Google, GitHub, Facebook, Email/Password)
    • Enable Firestore Database
    • Go to Project Settings > Your Apps > Web App
    • Copy the config values to .env.local
  4. Run development server

    npm run dev
  5. Open in browser

    http://localhost:5173/resume-builder/
    

🎯 Tech Stack

Category Technology
Frontend React 18 + Vite
UI Framework Tailwind CSS + shadcn/ui
State Management React Context API
Backend Firebase (Auth + Firestore)
Export jsPDF, html2canvas, docx.js, file-saver
Deployment GitHub Pages
Language JavaScript (ES6+)

πŸ“‚ Project Structure

resume-builder/
β”œβ”€β”€ public/                 # Static assets
β”‚   β”œβ”€β”€ manifest.json      # PWA manifest
β”‚   └── logo.svg           # App logo
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”œβ”€β”€ ui/            # Reusable UI components (Button, Card, etc.)
β”‚   β”‚   β”œβ”€β”€ common/        # Common utilities (ErrorBoundary, LazyLoad)
β”‚   β”‚   β”œβ”€β”€ layout/        # Header, Footer, Sidebar, Layout
β”‚   β”‚   β”œβ”€β”€ sections/      # 11 resume sections
β”‚   β”‚   β”œβ”€β”€ preview/       # Resume templates (6 templates)
β”‚   β”‚   β”œβ”€β”€ export/        # Export UI (PDF, DOCX, TXT)
β”‚   β”‚   β”œβ”€β”€ auth/          # Authentication modal
β”‚   β”‚   β”œβ”€β”€ tips/          # Tips panel with action verbs
β”‚   β”‚   └── features/      # Sample data, progress tracker
β”‚   β”œβ”€β”€ lib/               # Utilities & Firebase config
β”‚   β”‚   β”œβ”€β”€ firebase.js    # Firebase initialization
β”‚   β”‚   β”œβ”€β”€ storage.js     # LocalStorage + Firestore sync
β”‚   β”‚   └── export/        # Export logic (PDF, DOCX, TXT)
β”‚   β”œβ”€β”€ hooks/             # Custom React hooks
β”‚   β”‚   β”œβ”€β”€ useResume.js   # Resume data hook
β”‚   β”‚   β”œβ”€β”€ useAuth.js     # Authentication hook
β”‚   β”‚   β”œβ”€β”€ useTheme.js    # Theme management
β”‚   β”‚   └── useDebounce.js # Performance optimization
β”‚   β”œβ”€β”€ context/           # Global state management
β”‚   β”‚   β”œβ”€β”€ ResumeContext.jsx
β”‚   β”‚   β”œβ”€β”€ AuthContext.jsx
β”‚   β”‚   β”œβ”€β”€ ThemeContext.jsx
β”‚   β”‚   └── ToastContext.jsx
β”‚   β”œβ”€β”€ data/              # Constants & sample data
β”‚   β”‚   β”œβ”€β”€ actionVerbs.js
β”‚   β”‚   └── sampleData.js
β”‚   β”œβ”€β”€ styles/            # Global CSS
β”‚   β”œβ”€β”€ App.jsx            # Main app component
β”‚   └── main.jsx           # Entry point
β”œβ”€β”€ .env.example           # Environment template
β”œβ”€β”€ .env.local            # Your Firebase config (not committed)
β”œβ”€β”€ vite.config.js        # Vite configuration
β”œβ”€β”€ tailwind.config.js    # Tailwind configuration
└── package.json          # Dependencies

πŸ“‹ Resume Sections

Section Description Required
πŸ“Š Dashboard Progress tracker & quick stats -
πŸ‘€ Profile Name, contact, summary, photo βœ… Yes
πŸŽ“ Education Degrees, CGPA, coursework βšͺ Optional
πŸ’Ό Experience Internships, jobs βšͺ Optional
πŸš€ Projects Personal/academic projects βšͺ Optional
⚑ Skills Technical skills categorized βšͺ Optional
πŸ“œ Certifications Online courses, certificates βšͺ Optional
πŸ† Achievements Awards, competitions βšͺ Optional
πŸ‘₯ Leadership Positions of Responsibility βšͺ Optional
πŸ“„ Publications Research papers βšͺ Optional
🎯 Extracurricular Clubs, volunteering βšͺ Optional
🌐 Languages Language proficiency βšͺ Optional

🎨 Available Templates

  1. Classic - Traditional corporate style
  2. Modern - Contemporary design with colors
  3. Minimal - Clean and simple
  4. Two-Column - Efficient space usage
  5. Compact - More content per page
  6. ATS-Friendly - Optimized for applicant tracking systems

Each template supports:

  • Beautiful mode (for human readers)
  • ATS mode (for automated scanners)

πŸ“₯ Export Formats

PDF

  • Beautiful PDF - Styled with colors, fonts, spacing
  • ATS-Friendly PDF - Plain text, no graphics, scanner-optimized

DOCX

  • Microsoft Word format
  • Editable after export
  • Compatible with Google Docs, LibreOffice

Plain Text

  • Copy-paste ready
  • For online application forms
  • ASCII formatting preserved

🚒 Deployment

Deploy to GitHub Pages

  1. Update repository name in vite.config.js (if different)

    base: '/resume-builder/'  // Change if your repo name is different
  2. Build and deploy

    npm run deploy
  3. Enable GitHub Pages

    • Go to repository Settings > Pages
    • Source: gh-pages branch
    • Save
  4. Access your app

    https://goldlion123rp.github.io/resume-builder/
    

🀝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

Quick Contribution Steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit changes (git commit -m 'Add AmazingFeature')
  4. Push to branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ› Bug Reports & Feature Requests

Found a bug? Have a feature idea?

πŸ‘‰ Open an issue


πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


πŸ™ Acknowledgments

  • Built with ❀️ for students by Rahul Pal
  • UI components from shadcn/ui
  • Icons from Lucide
  • Hosted on GitHub Pages
  • Inspired by the need for free, student-friendly resume tools

πŸ“§ Contact

Rahul Pal


πŸ—ΊοΈ Roadmap

  • AI Resume Scoring & Suggestions
  • LinkedIn Profile Import
  • Shareable Resume Links (public URLs)
  • Cover Letter Builder
  • Multi-language Support (Hindi, Bengali)
  • Chrome Extension for quick access
  • Resume Version History
  • PDF Parsing (upload existing resume)

⭐ Star History

If this project helped you, please give it a ⭐ star!

Star History Chart


πŸ“Š Project Stats

GitHub repo size GitHub stars GitHub forks GitHub issues GitHub pull requests


Made with πŸ’™ in West Bengal, India

About

Free ATS-friendly Resume Builder for students - React, Firebase, Tailwind CSS

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages