Skip to content

development.md

Latest commit

 

History

History
68 lines (52 loc) · 2.03 KB

development.md

File metadata and controls

68 lines (52 loc) · 2.03 KB

Local Development Guide

This guide provides detailed instructions for developers who need to run and debug the backend services natively (outside of Docker) on their local machine.

For running the entire backend stack at once, please refer to the Docker Compose instructions in the main README.

Prerequisites

Before running any service, ensure you have completed the following setup steps:

  1. Database Ready: Your YugabyteDB instance must be running and accessible. The schema should be applied as described in the Database Guide.

  2. Environment Configuration:

    • Copy the root .env.example file to .env: cp .env.example .env
    • Fill in all the required values (DATABASE_URL, GEMINI_API_KEY, etc.). Both services will source their configuration from this central file.

💻 Running the API Service Natively

Follow these steps to run the API & AI service directly on your machine with hot-reloading for active development.

  1. Navigate to the service directory: 
    cd api_service
  2. Create and activate a Python virtual environment: 
    python3 -m venv venv
source venv/bin/activate
  3. Install dependencies: 
    pip install -r requirements.txt
  4. Run the development server: 
    uvicorn app.main:app --reload

The API service will be available at http://localhost:8000.

📦 Running the Ingestion Service Natively

Follow these steps to run the Ingestion service directly on your machine.

  1. Navigate to the service directory: 
    cd ingestion_service
  2. Install dependencies: 
    npm install
  3. Run the development server: 
    npm run dev

The Ingestion service will be available at http://localhost:3000.


‎ </> Built by Mission Control | DevByZero 2025

Defining the infinite possibilities in your DevOps pipeline. ‎