mirror of https://github.com/srbhr/Resume-Matcher.git synced 2026-01-14 11:44:14 +00:00

Files

srbhr 1ccdebb6c4 docs: add comprehensive documentation for new features

- Introduced JD Match feature documentation detailing how tailored resumes match job descriptions.
- Added Resume Template Settings documentation outlining template types and formatting controls.
- Created LLM Integration Guide for multi-provider AI support, JSON handling, and prompt guidelines.
- Compiled Agent Documentation Index for modular documentation on AI agents working with Resume Matcher.
- Developed Maintainer Guide for the resume editor, covering architecture, types, and PDF handling.
- Established a Code Review & Technical Debt TODO document to track critical issues and improvements.

2026-01-05 23:36:27 +05:30

1.8 KiB

Raw Permalink Blame History

Quickstart Guide

Essential commands to build, run, and test Resume Matcher.

Prerequisites

Node.js 18+
Python 3.11+
uv (Python package manager)

Installation

# Install all dependencies (frontend + backend)
npm run install

This provisions:

Frontend: npm install in apps/frontend/
Backend: uv sync in apps/backend/

Development

# Start both servers concurrently
npm run dev

# Or run individually:
npm run dev:backend   # FastAPI on :8000
npm run dev:frontend  # Next.js on :3000

Production Builds

# Build both stacks
npm run build

# Build frontend only
npm run build:frontend

Quality Checks

# Lint frontend
npm run lint

# Format with Prettier
npm run format

Backend Commands

cd apps/backend

# Start with auto-reload
uv run uvicorn app.main:app --reload --port 8000

# Run tests (when available)
uv run pytest

Frontend Commands

cd apps/frontend

# Development with Turbopack
npm run dev

# Production build
npm run build

# Start production server
npm run start

Environment Setup

Backend

Copy apps/backend/.env.example to apps/backend/.env:

cp apps/backend/.env.example apps/backend/.env

Frontend

Copy to apps/frontend/.env.local:

cp apps/frontend/.env.sample apps/frontend/.env.local

Note

: Only template files (.example, .env.local.example) belong in Git.

First-Time Setup Checklist

Open http://localhost:3000/settings
Select your AI provider
Enter your API key (or configure Ollama)
Click "Save Configuration"
Click "Test Connection" to verify it works
Return to Dashboard and upload your first resume!

1.8 KiB Raw Permalink Blame History