Skip to content

Latest commit

 

History

History

README.md

Agent Documentation Index

Complete reference for AI agents working with Resume Matcher.

Start with the topics below.

Quick Navigation

Core Docs

Doc Purpose
scope-and-principles Rules, what's in/out of scope
quickstart Install, run, test commands
workflow Git, PRs, testing
coding-standards Frontend/backend conventions

Architecture

Doc Purpose
backend-architecture Backend modules, API, services
frontend-architecture Components, pages, state

APIs

Doc Purpose
front-end-apis API contract
api-flow-maps Request/response flows

Design

Doc Purpose
style-guide Swiss International Style
template-system Resume templates
pdf-template-guide PDF rendering

Features

Doc Purpose
custom-sections Dynamic sections
i18n Internationalization

LLM Integration

Doc Purpose
llm-integration Multi-provider AI

Project Structure

apps/
├── backend/                 # FastAPI + Python
│   ├── app/
│   │   ├── main.py          # Entry point
│   │   ├── routers/         # API endpoints
│   │   ├── services/        # Business logic
│   │   └── prompts/         # LLM templates
│   └── data/                # Database storage
│
└── frontend/                # Next.js + React
    ├── app/                 # Pages
    ├── components/          # UI components
    └── lib/                 # Utilities, API client

How to Use

New tasks: Read scope-and-principlesquickstartworkflow

Backend changes: backend-architecturefront-end-apisllm-integration

Frontend changes: frontend-architecturestyle-guidecoding-standards

Template/PDF changes: pdf-template-guidetemplate-system