Skip to content

kofi-bhr/resumeroaster

Repository files navigation

🔥 ResumeRoaster

A modern, AI-powered resume analysis tool built by a high school student to help Friends students perfect their resumes.

Next.js TypeScript Tailwind CSS Google Gemini Vercel Next.js React shadcn/ui macOS npm TypeScript Git

🚀 Features

  • 📊 Advanced resume analysis using Google's Gemini AI
  • 💡 Smart recommendations for improvements
  • 📱 Responsive, modern UI built with Next.js and Tailwind CSS
  • 📈 Visual feedback and scoring system
  • ⚡️ Real-time processing and feedback
  • 🎨 Beautiful, accessible design with Radix UI components

🛠 Tech Stack

  • Frontend Framework: Next.js 15.1
  • Language: TypeScript
  • Styling: Tailwind CSS
  • UI Components: Radix UI
  • AI Integration: Google Gemini API
  • Form Handling: React Hook Form + Zod
  • Animations: Framer Motion
  • Charts: Chart.js with react-chartjs-2

🏃‍♂️ Quick Start

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn
  • A Google Gemini API key

Setup

  1. Clone the repository

    git clone https://github.com/yourusername/resumeroaster.git
    cd resumeroaster
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Set up environment variables

    cp .env.example .env.local

    Then, add your Google Gemini API key to .env.local:

    GEMINI_API_KEY="your_api_key_here"
    
  4. Run the development server

    npm run dev
    # or
    yarn dev
  5. Open your browser Navigate to http://localhost:3000

🔑 Getting a Gemini API Key

  1. Visit the Google AI Studio
  2. Create or # to your Google account
  3. Generate a new API key
  4. Copy the key and paste it into your .env.local file

📚 Project Structure

resumeroaster/
├── src
│   ├── app/         # Next.js app router pages
│   ├── components/  # Reusable UI components
│   ├── lib/         # Utility functions and configurations
│   └── types/       # TypeScript type definitions
├── public/          # Static assets
└── ...config files  # Various configuration files

🧪 Key Features Explained

  • AI Analysis: Leverages Google's Gemini AI to provide detailed resume feedback
  • Modern UI: Built with the latest Next.js features and Tailwind CSS for a sleek look
  • Type Safety: Full TypeScript implementation for robust code quality
  • Component Library: Custom components built on Radix UI primitives
  • Form Validation: Zod schema validation for reliable data handling
  • Responsive Design: Fully responsive layout that works on all devices

🤝 Contributing

Contributions are welcome! Feel free to:

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Submit a pull request

📝 License

This project is open source and available under the MIT License.

🙋‍♂️ About the Developer

Built by Kofi, a high school student and head of business club at Friends School, to help fellow students improve their resumes.


⭐️ If you found this helpful, please star the repo!

For questions or feedback, feel free to open an issue or reach out directly.