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
- uv - Fast Python package manager (install guide)
- Docker - Needed when you choose local Docker PostgreSQL, Redis, or MinIO in the setup wizard
Recommended Path¶
- Quick Start - Run the setup wizard and start the application locally
- Project Structure - Understand where things are located
- Development Environment - Set up your IDE and tools
- 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.