Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nayalsaurav/resume-analyzer/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you from zero to a running local instance of Resume Check Karo. By the end you will have the development server running at http://localhost:3000 with AI-powered resume analysis fully functional. The entire setup takes under five minutes once your external accounts and API keys are ready.

​
Prerequisites

Before you begin, make sure you have the following:
  • Node.js 18+ — Download from nodejs.org. Run node -v to confirm your version.
  • PostgreSQL database — A local Postgres instance, or a hosted provider such as Neon or Supabase.
  • Google Cloud account — Needed to generate a Gemini API key via Google AI Studio.
  • Clerk account — Sign up at clerk.com to get your publishable and secret keys.
  • ImageKit account — Sign up at imagekit.io for file storage credentials.

​
Setup Steps

1

Clone the Repository

Clone the project from GitHub and navigate into the project directory:
git clone https://github.com/nayalsaurav/resume-analyzer.git && cd resume-analyzer
2

Install Dependencies

Install all required packages using your preferred package manager:
npm install
3

Set Up Environment Variables

Create a .env.local file in the project root and populate it with your credentials:
.env.local
# PostgreSQL
DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE"

# Google Gemini AI
GOOGLE_API_KEY="your-google-api-key"
GOOGLE_AI_MODEL="gemini-1.5-flash"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_..."
CLERK_SECRET_KEY="sk_test_..."

# ImageKit
NEXT_PUBLIC_IMAGEKIT_URL_ENDPOINT="https://ik.imagekit.io/your_imagekit_id"
IMAGEKIT_PUBLIC_KEY="your_imagekit_public_key"
IMAGEKIT_PRIVATE_KEY="your_imagekit_private_key"
See the Environment Setup guide for step-by-step instructions on obtaining each key.
4

Run Database Migrations

Apply the Prisma schema to your PostgreSQL database. This creates all required tables:
npx prisma migrate dev
If prompted for a migration name, enter something descriptive like init. Prisma will also automatically run prisma generate to produce the typed client.
5

Start the Development Server

Launch the Next.js development server:
npm run dev
npm run dev uses Next.js Turbopack, which provides significantly faster hot module replacement and cold start times compared to the legacy webpack bundler. You will see a ▲ Next.js 15 banner with (turbopack) confirmed in your terminal output.
6

Open the App

With the server running, open your browser and navigate to:
http://localhost:3000
You will land on the Resume Check Karo home page. Click Sign Up to create an account via Clerk, then head to the Dashboard to upload your first resume.

​
Available Scripts

The following npm scripts are defined in package.json:
ScriptCommandDescription
devnext dev --turbopackStart the development server with Turbopack
buildnext buildProduce an optimized production build
startnext startServe the production build locally
postbuildnext-sitemapGenerate a sitemap automatically after each build

​
App Routes

Once the app is running, here is a quick map of the available pages:
RouteDescription
/Landing page with hero section
/dashboardUpload form — submit your PDF resume and job description
/dashboard/resume/[id]Individual resume analysis and scorecard
/signinClerk-hosted sign-in page
/signupClerk-hosted sign-up page

Build docs developers (and LLMs) love

Get started for freeTalk to us