Skip to content

jacantwell/kairos-backend

Repository files navigation

Kairos Backend

Current deployment -> https://7zpmbpgf7d.execute-api.eu-west-2.amazonaws.com/docs

Backend Developer Guide

This backend is built with FastAPI, Pydantic, MongoDB (via pymongo), and managed using Poetry. It serves as the API and data layer for the project.

🛠️ Tech Stack

  • FastAPI: Web framework for building APIs
  • Pydantic: Data validation and settings management
  • MongoDB: NoSQL database
  • pymongo: MongoDB driver for Python
  • Uvicorn: ASGI server for running FastAPI
  • Poetry: Dependency and environment management

🚀 Getting Started

1. Install Dependencies

Make sure you have Poetry installed.

poetry install

2. Environment Variables

Copy the example environment file and fill in your MongoDB credentials:

cp .env.example .env
# Edit .env with your MongoDB details

3. Run the local Development Server

Use the provided script to start the server with hot-reload:

sh scripts/start_server.sh

4. Project Structure

kairos/
├── main.py             # FastAPI app entrypoint
├── api/                # API routers
├── models/             # Pydantic models
├── database/           # MongoDB drivers and connection logic
├── core/               # Configuration and settings

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published