BacMR Documentation

Welcome to the official technical documentation for the BacMR (Baccalaureate Mauritania) backend. This is a production-ready FastAPI backend designed to power the BacMR React frontend application.

Status

Area	Status
Backend API	41 endpoints across 7 routers
Test Suite	148 tests, all passing (pytest)
Coverage	58% (services + routers well-covered)
Frontend	React app integration in progress

Navigation Index

00. Overview

• Product Vision & User Stories
• Start Here (Quick Orientation)
• System Architecture
• Glossary of Terms

10. Current State

• Repository Structure
• API Inventory (41 endpoints)
• Environment Variables
• Supabase (Relational DB) State
• Pinecone (Vector DB) State
• Deployment Status (Render)

20. Runbooks

• Local Development Setup
• Testing Guide
• Deployment Guide (Render)
• Postman Testing Guide
• SSE Streaming Guide
• Troubleshooting

30. System Design

• Backend Architecture (Consolidated) — Full architecture spec, API contracts, schema, task list
• Scraping Platform
• Ingestion & Vector Embedding
• Chat Agent (LangGraph)
• Auth & Admin Roles
• Wallet & Billing System
• RLS (Row Level Security) Plan

90. Operations & Governance

• Progress Tracker
• Backlog
• Changelog
• AI-Driven SDLC Workflow
• Architecture Decision Records (ADR)

---

How to use these docs

• For Frontend Developers: Start with API Inventory and Testing Guide.
• For New AI Agents: Read docs/10_current_state/ to understand the codebase context.
• For Solo Developers: Use docs/20_runbooks/ for setup and docs/90_ops/ai_workflow.md to maintain speed.
• For Architects: Refer to docs/30_design/ and docs/90_ops/decisions/.