Job-craft-ai

Installation Instructions

1. Clone the Repository

git clone <repository-url>
cd Job-craft-ai

2. Backend Setup

cd backend
npm install

Create a .env file and configure the following variables:

MONGO_URI=
JWT_SECRET=
GOOGLE_GENAI_API_KEY=
FRONTEND_URL=
NODE_ENV=

Start the backend server:

npm run dev // npm start

3. Frontend Setup

cd frontend
npm install

Create a .env file:

VITE_API_URL=

Start the frontend application:

npm run dev

4. Access the Application

Open your browser and navigate to:

https://job-craft-ai.vercel.app/

Usage Instructions

1. Register a new account or log in using existing credentials.
2. Upload a resume in the supported format.
3. Submit the resume for AI-based analysis.
4. Review the generated ATS score and detailed feedback.
5. Analyze identified weaknesses, missing sections, and improvement suggestions.
6. Use the AI-generated recommendations to enhance resume content.
7. Download or update the improved resume for future applications.

Hardware Requirements

ComponentMinimum RequirementRecommended RequirementProcessorIntel Core i3 (2nd Gen) / AMD equivalentIntel Core i5 (8th Gen or above) / AMD Ryzen 5RAM4 GB8 GB or higherStorage1 GB free disk space5 GB free disk space (SSD preferred)Internet ConnectionStable broadband connectionHigh-speed broadband connectionDisplay Resolution1366 × 7681920 × 1080 (Full HD)

Software Requirements

ComponentRequirementOperating SystemWindows 10/11, Ubuntu 20.04+, or macOS 12+Runtime EnvironmentNode.js v18 or laterPackage Managernpm v9 or laterDatabaseMongoDB Community Server v6+ or MongoDB AtlasWeb BrowserGoogle Chrome, Mozilla Firefox, Microsoft Edge, or Safari (latest versions)Code EditorVisual Studio Code (recommended)Version ControlGit v2.30 or laterAI ServiceGoogle Gemini API access with a valid API key

Runtime Requirements

• Active internet connection for AI-powered resume analysis.
• Valid Google Gemini API credentials configured in the backend environment.
• MongoDB instance (local or cloud-hosted) running and accessible.
• Frontend and backend services configured through environment variables.

Supported File Formats

• Resume Uploads: PDF (.pdf) and DOCX (.docx) (adjust this if your project supports different formats).
• Configuration Files: .env and .env.example.
• API Communication: JSON over HTTP/HTTPS.