Co-design Backend — Developer Documentation

Technical documentation for developers working on the Co-design backend services.

Getting Started

• Installation
  • Prerequisites
  • Clone the Repository
  • Environment Configuration
  • Start with Docker Compose (Recommended)
  • Local Development (Without Docker)
  • Frontend Setup
  • Troubleshooting
• Quick Start
  • 1. Start the Platform
  • 2. Create a User
  • 3. Run the Initial Diagnosis
  • 4. Create a Project
  • 5. Invite Collaborators
  • 6. Start the Chat Assistant
  • 7. Work Through the Phases
  • Next Steps

Architecture

• System Overview
  • Design Principles
  • Request Flow
  • Network Topology
• Backend Structure
  • Directory Layout
  • Layer Responsibilities
  • Key Patterns
• Data Models
  • Entity Relationship Diagram
  • Core Models
  • Phase-Specific Models
• AI Orchestrator
  • Architecture Overview
  • Agent Types
  • LLM Configuration
  • RAG Pipeline
  • State Persistence
  • Form Triggers
  • Carbon Tracking

API Reference

• API: Projects
  • Endpoints
• API: Templates
  • Endpoints
  • Template Codes Reference
  • Field Naming Convention
• API: Chat
  • Endpoints
  • Frontend Integration
• API: Initial Diagnosis
  • Endpoints
  • Diagnosis Modes
  • Dimensions
• API: Users
  • Endpoints
  • Authentication

Configuration & Deployment

• Environment Variables
  • Required Variables
  • Optional Variables
• Docker Compose
  • Service Definitions
  • Networks
  • Volumes
  • Common Operations
  • Multi-Environment Support
• Database Migrations
  • Auto-Migration (Development)
  • Alembic (Production)
  • Schema Management Rules
  • LangGraph Checkpoint Tables
  • UUID Generation
  • Connection Configuration

Development

• Testing
  • Test Structure
  • Running Tests
  • Test Categories
  • Key Fixtures (conftest.py)
  • Load Testing with Locust
  • LLM Evaluation with DeepEval
• Contributing
  • Development Setup
  • Code Style
  • Branch Strategy
  • Adding a New API Endpoint
  • Adding a New Agent
  • Adding a New Template Type
  • Running CI Locally

Developer Reference (autodoc)

• Developer Reference
  • AI Agents
  • Configuration & Permissions
  • Data Models (ORM)
  • Orchestrator Core
  • Repositories
  • API Routers
  • Pydantic Schemas
  • Business Services