Skip to content

AGENTS.md

Latest commit

 

History

History
53 lines (39 loc) · 1.34 KB

AGENTS.md

File metadata and controls

53 lines (39 loc) · 1.34 KB
Raw

AGENTS.md

This file provides guidance for AI coding agents (Codex, Copilot, Cursor, Zed, OpenCode).

Project Overview

proj2 - FastAPI application generated with Full-Stack AI Agent Template.

Stack: FastAPI + Pydantic v2, PostgreSQL , JWT + API Key auth, Redis , pydantic_ai (google), Next.js 15 (i18n)

Commands

# Run server
cd backend && uv run uvicorn app.main:app --reload

# Tests & lint
pytest
ruff check . --fix && ruff format .

# Migrations
uv run alembic upgrade head
uv run alembic revision --autogenerate -m "Description"

Project Structure

backend/app/
├── api/routes/v1/    # Endpoints
├── services/         # Business logic
├── repositories/     # Data access
├── schemas/          # Pydantic models
├── db/models/        # DB models
├── agents/           # AI agents
└── commands/         # CLI commands

Key Conventions

  • db.flush() in repositories, not commit()
  • Services raise NotFoundError, AlreadyExistsError
  • Separate Create, Update, Response schemas
  • Commands auto-discovered from app/commands/

More Info

  • docs/architecture.md - Architecture details
  • docs/adding_features.md - How to add features
  • docs/testing.md - Testing guide
  • docs/patterns.md - Code patterns