Quick Start Guide
=================

.. verified:: 2025-12-09
   :reviewer: Christof Buchbender

Welcome to the ops-db-api quick start guide! This section will help you get the API
running locally and make your first API calls.

.. contents:: Table of Contents
   :local:
   :depth: 2

What You'll Learn
-----------------

In this quick start guide, you'll learn how to:

1. Install the API and its dependencies
2. Configure environment variables and services
3. Start the API server
4. Make your first authenticated API call
5. Run the complete stack locally with Docker Compose

Prerequisites
-------------

Before you begin, ensure you have:

* Python 3.9 or higher
* Git
* PostgreSQL (or Docker to run it)
* Redis (or Docker to run it)
* Basic familiarity with REST APIs and Python

Time Estimate
-------------

* **Minimal setup**: 10-15 minutes
* **Full Docker Compose stack**: 5 minutes
* **First API call**: 5 minutes

Next Steps
----------

.. toctree::
   :maxdepth: 1

   installation
   first-api-call
   running-locally

Choose your path:

* **New to the project?** Start with :doc:`installation`
* **Want the fastest setup?** Jump to :doc:`running-locally` for Docker Compose
* **Ready to explore?** Learn about :doc:`first-api-call`

After the Quick Start
----------------------

Once you've completed this guide, you should:

* Understand the :doc:`../philosophy/index` behind the API design
* Explore the :doc:`../architecture/index` for technical details
* Follow :doc:`../tutorials/index` to build your own endpoints