Skip to content

Repository files navigation

HireMyAI v1.0.0

An AI-powered content generator that helps job seekers create tailored cover letters, recruiter responses, and follow-up messages using OpenAI's GPT API.

Features

  • 🤖 AI-Powered Generation: Uses OpenAI's GPT-3.5 to generate personalized content
  • 📝 Resume Storage: Automatically saves and loads your resume for convenience
  • 🎨 Multiple Content Types: Generate cover letters, email responses, or outreach messages
  • 🎯 Multiple Tones: Choose from professional, casual, or witty tones
  • 📊 Usage Tracking: 10 free generations per day with automatic daily reset
  • 📱 Mobile-First Design: Fully responsive design that works on all devices
  • 🎨 Beautiful UI: Built with PrimeReact and TailwindCSS using the Lara Dark Amber theme
  • 📄 PDF Export: Export generated content as PDF
  • 📋 Copy to Clipboard: Easy copying of generated content
  • 🧙‍♂️ Wizard-Themed Experience: Magical notifications and loading animations
  • Loading Overlay: Wizard-themed loading spinner during content generation

Tech Stack

  • Framework: Next.js 15+ with App Router
  • Language: TypeScript
  • Styling: TailwindCSS + PrimeReact
  • UI Components: PrimeReact (Lara Dark Amber theme)
  • AI: OpenAI GPT-3.5 API
  • PDF Export: html2pdf.js
  • Form Handling: React Hook Form
  • Validation: Zod

Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • OpenAI API key

Installation

  1. Clone the repository

    git clone <repository-url>
    cd hire-my-ai
  2. Install dependencies

    npm install
  3. Set up environment variables Create a .env.local file in the root directory:

    OPENAI_API_KEY=your_openai_api_key_here

    Get your OpenAI API key from: https://platform.openai.com/api-keys

  4. Run the development server

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

Usage

  1. Homepage: Click "Get Started" to begin
  2. Resume Input: Paste your resume (automatically saved for next time)
  3. Job Posting: Paste the job description and select your preferred tone
  4. Generate: Use the SplitButton to choose your content type:
    • Cover Letter: Traditional job application format
    • Email Response: Reply to a recruiter's email
    • Outreach: Cold email to introduce yourself
  5. Review & Export: Review the generated content and export as PDF or copy to clipboard

Project Structure

src/
├── app/                    # Next.js App Router pages
│   ├── api/               # API routes
│   ├── builder/           # Resume & job input page
│   ├── result/            # Generated content display page
│   └── layout.tsx         # Root layout with providers
├── components/            # Reusable UI components
│   ├── hero-section.tsx   # Homepage hero component
│   ├── resume-input.tsx   # Resume input component
│   ├── job-posting-input.tsx # Job posting input component
│   ├── usage-display.tsx  # Daily usage tracker
│   └── toast-provider.tsx # Toast context provider
├── lib/                   # Library configurations
│   └── providers/         # React providers
├── types/                 # TypeScript type definitions
├── utils/                 # Utility functions
└── hooks/                 # Custom React hooks

API Routes

  • POST /api/generate - Generates content using OpenAI with support for multiple types

Environment Variables

Variable Description Required
OPENAI_API_KEY Your OpenAI API key Yes

Deployment

Netlify (Recommended)

  1. Connect your repository to Netlify
  2. Build settings (automatically configured via netlify.toml):
    • Build command: npm run build
    • Publish directory: .next
    • Node version: 18
  3. Add environment variables in Netlify dashboard:
    • OPENAI_API_KEY: Your OpenAI API key
  4. Deploy

The project includes a netlify.toml file that automatically configures:

  • Build command and publish directory
  • Node.js version
  • Redirects for SPA routing
  • Serverless functions configuration

Vercel

  1. Import your repository to Vercel
  2. Add environment variables in Vercel dashboard
  3. Deploy

Manual Deployment

  1. Build the project

    npm run build
  2. Deploy the .next directory to your hosting provider

Development

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run start - Start production server
  • npm run lint - Run ESLint

Local Development

The app is configured to work seamlessly in both local development and production environments. The API routes will work locally with your .env.local file and on Netlify with environment variables set in the dashboard.

Changelog

See CHANGELOG.md for a complete list of changes and features.

Contributing

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

License

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

Support

If you encounter any issues or have questions, please open an issue on GitHub.


Built with ❤️ using Next.js, TypeScript, and OpenAI

About

AI-powered job application assistant that helps you generate custom cover letters, recruiter replies, and follow-up messages using your resume and a job description.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages