Quick Start Guide#

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.

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#

Choose your path:

After the Quick Start#

Once you’ve completed this guide, you should: