RUE API

FastAPI backend for the Rapid Urbanism Explorer (RUE).

---

Installation

System Requirements

API is using rue-lib library that requires GDAL to be installed on your system. Install it before installing running this api:

macOS (using Homebrew):

brew install gdal

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install -y gdal-bin libgdal-dev

Windows: Download from OSGeo4W or use conda.

Quickstart

# 1) Create & activate venv (optional)
python -m venv .venv
source .venv/bin/activate

# 2) Install deps
pip install -U pip
pip install -e .

# 3) Create a .env
cp .env.example .env

# 4) Run DB migrations
alembic revision --autogenerate -m "init"   # first time, if you have models
alembic upgrade head

# 5) Start the API
uvicorn app.main:app --reload