Skip to content

dharunkumar-sh/ai-resume-builder

Repository files navigation

Stars Forks Version Tech Tech Auth AI DB Deploy

🚀 AI Resume Builder

Create professional, AI‑generated resumes with a modern web interface.

Stars Forks Version Tech Stack Tech Stack Auth AI Database Deploy

Description
The AI Resume Builder is a full‑stack web application that enables users to design, edit, and export polished resumes using AI assistance. Leveraging Clerk for secure authentication, Gemini (Google Generative AI) for content generation, and PostgreSQL for data persistence, the app offers a seamless experience built with React, Tailwind CSS, and the shadcn/ui component library. Deployed on Vercel, it provides instant scaling and a fast, responsive UI.

📚 Table of Contents

Click to expand TOC

✨ Features

Key Capabilities
  • AI‑Powered Resume Generation – Prompt‑based creation using Gemini API.
  • Template Library – Pre‑designed resume layouts selectable via the dashboard.
  • Real‑Time Preview – Live view of the resume as you edit.
  • Rich Text Editing – Full‑featured editor for sections like Experience, Education, Skills.
  • Theme Customization – Adjust colors and fonts with the ThemeColor component.
  • Secure Authentication – Clerk OAuth integration for instant sign‑in.
  • Export Options – Download resumes as PDF or shareable links.
  • Responsive Design – Tailored for desktop, tablet, and mobile viewports.

🛠️ Tech Stack

Technologies & Tools
Category Technology
Frontend React 18, TypeScript (JSX), Tailwind CSS
UI Library shadcn/ui (Radix UI components)
Auth Clerk (OAuth2)
AI Google Gemini API (Generative AI)
Backend Node.js (Vite) + Axios for API calls
Database PostgreSQL (via Prisma/ORM)
Deployment Vercel (Serverless)
Dev Tools Vite, ESLint, eslint‑plugin‑react‑hooks, JSDoc types
Styling CSS Modules / Tailwind utilities

🚀 Getting Started

Installation & Setup

Prerequisites

  • Node.js ≥ 18.x
  • npm ≥ 9.x (or Yarn)
  • Git

Installation

# Clone the repository
git clone https://github.com/dharunkumar-sh/ai-resume-builder.git
cd ai-resume-builder

# Install dependencies
npm install

Environment Variables

Create a .env file in the project root with the following keys (values are example placeholders):

VITE_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
VITE_CLERK_SECRET_KEY=your_clerk_secret_key
VITE_GEMINI_API_KEY=your_gemini_api_key
VITE_POSTGRES_URL=postgresql://user:password@host:5432/resumes

Note: Replace the placeholders with your actual credentials. The app uses Vite's import.meta.env to expose these variables.

Development Server

npm run dev

Open http://localhost:5173 to view the app.

Production Build

npm run build
npm run preview   # preview the built app locally

Deploy to Vercel using the provided vercel-deployment configuration.

📖 Usage

Quick Start Guide

Create a New Resume

  1. Sign In – Use the Sign In button (Clerk OAuth).
  2. Select Template – Navigate to Dashboard → Resume → Add Resume and pick a layout.
  3. AI Generation – Click Generate with AI; provide a short prompt (e.g., “Create a senior software engineer resume”). The AI will populate the sections automatically.

Edit & Customize

  • Use the Rich Text Editor for free‑form editing.
  • Adjust Theme Colors via the ThemeColor component to match your personal brand.
  • Add or remove sections (Education, Experience, Skills, etc.) through the **

About

AI Resume Builder Web Application

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors