Skip to content

README.md

Latest commit

 

History

History
85 lines (62 loc) · 2.26 KB

README.md

File metadata and controls

85 lines (62 loc) · 2.26 KB

AI Resume Builder

An AI-powered resume building platform with ATS optimization, drag-and-drop editing, and multiple professional templates.

✨ Features

Core

  • AI Resume Analysis - Feedback and optimization suggestions
  • Resume Builder - Drag-and-drop interface with real-time editing
  • Multiple Templates - Modern, Classic, Creative, and Minimal designs
  • ATS Optimization - Keyword matching and format scoring
  • Export Options - PDF, Word, and HTML formats
  • Theme Support - Light, Dark, and System themes

Tech Stack

  • Frontend - React 18, TypeScript, Vite, Tailwind CSS
  • State Management - Zustand with persistence
  • Component Library - Shadcn/ui with custom theming
  • Type Safety - Comprehensive TypeScript interfaces

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/Uday9909/AI-Resume-Builder.git
cd AI-Resume-Builder

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

📱 Application Structure

Pages

  • Dashboard (/) - Overview and quick actions
  • Resume Builder (/builder) - Create and edit resumes
  • AI Analysis (/analysis) - AI-powered feedback
  • Templates (/templates) - Browse resume templates
  • Settings (/settings) - User preferences

State Management

  • Zustand Store - Centralized state management
  • Persistent Storage - User preferences and data
  • Real-time Updates - Instant UI synchronization

🔒 Privacy

  • User data stays on device via local storage
  • No external data sharing
  • Full data export and import support

🤝 Contributing

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

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

  • Shadcn/ui — Component library
  • Tailwind CSS — Utility-first CSS framework
  • Vite — Fast build tool
  • Zustand — Lightweight state management

Built by Udaybir Singh
📫 writetoudaybir@gmail.com