Skip to content

Getting Started

This section helps you get the project running and understand its structure.

In This Section

Page Description
Quick Start Get the project running in minutes
Project Structure Understand the codebase organization
Development Environment Configure your development tools

Prerequisites

Before you begin, ensure you have:

  • Python 3.14+ - The project uses modern Python features
  • Docker - For running PostgreSQL, Redis, and MinIO
  • uv - Fast Python package manager (install guide)
  1. Quick Start - Get the application running locally
  2. Project Structure - Understand where things are located
  3. Development Environment - Set up your IDE and tools
  4. Tutorial - Learn by building a feature

Next Steps

Once you've completed the Getting Started section, head to the Tutorial to learn the architecture by building a complete feature.