Quick Start

Getting Started

Follow these steps to set up the Japanese ATS project locally on your machine. This application requires a Supabase instance to handle database storage, authentication, and resume processing.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18.0 or higher)
• npm or bun (package manager)
• A Supabase account (for backend services)
• A Resend API key (optional, for email notifications)

1. Clone the Repository

Start by cloning the project to your local environment:

git clone https://github.com/ashish-upadhyay2004/JapaneseATS-Resume-Analyzer.git
cd JapaneseATS-Resume-Analyzer

2. Install Dependencies

Install the required project dependencies using your preferred package manager:

# Using npm
npm install

# Using bun
bun install

3. Environment Configuration

Create a .env file in the root directory and add your Supabase credentials. These can be found in your Supabase Project Settings under API.

VITE_SUPABASE_URL=your_supabase_project_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

4. Database and Storage Setup

To ensure the application functions correctly, you must set up your Supabase project with the following:

1. Tables: Create an applicants table as defined in src/integrations/supabase/types.ts.
2. Storage: Create a public bucket named cvs to store uploaded PDF resumes.
3. Edge Functions: Deploy the functions located in the /supabase/functions directory:
   • parse-cv: Handles PDF text extraction and keyword matching.
   • send-status-notification: Manages email updates via Resend.

5. Launch the Development Server

Start the Vite development server to view the application:

npm run dev

Once the server is running, the application is accessible at http://localhost:5173.

User Workflows

Applicant View

• URL: /
• Action: Fill out the application form and upload a PDF resume.
• Validation: The system checks for PDF format and file size (max 5MB). Upon submission, the background parse-cv function will automatically analyze the resume for keywords.

Admin Dashboard

• URL: /admin/login
• Action: Log in using your Supabase Auth credentials.
• Dashboard: View the list of applicants, their automated "Match Scores," and update application statuses (Pending, Reviewed, Accepted, Rejected). Updating a status triggers an automated email notification to the candidate.