Welcome

Introduction

Introduction

Setup & Installation

Setup OverviewPrerequisitesQuick Start
Backend OverviewInstallationConfigurationRunning LocallyDevelopment Guide
MCP Servers

Architecture & Design

Architecture

Features & Scenarios

Deployment

Deployment

API Reference

API Reference

Tools & Utilities

Scripts & UtilitiesTroubleshooting
Setup & InstallationBackend Setup

Development Guide

Hot reload, debugging, and best practices

Development Guide

Hot reload, debugging, and best practices for backend development.

Hot Reload

The backend automatically reloads when you make changes thanks to uvicorn --reload.

Debugging

Set breakpoints in your IDE and use the debugger to step through code.

Best Practices

  • Use type hints for better IDE support
  • Write tests for new features
  • Follow the existing code structure

Next Steps

  • Backend Overview - Return to backend setup
  • Frontend Setup - Set up the frontend

Running Locally

Start the backend and verify it's working

Frontend Setup

Set up the SynapseAI React frontend

On this page

Development GuideHot ReloadDebuggingBest PracticesNext Steps