fst_data_pipeline-feature-editor-api/fst_data_pipeline/apps/README.md

# Micro Service Apps

Backend micro services for the FST data production line.

## Services

- `root_db_api`: FST/root database APIs (Flask + SQLAlchemy + PostgreSQL)
- `mta_manage_system`: MTA management service (Flask + Flask-SQLAlchemy)

## Prerequisites

- Python `>=3.12`
- `uv` package manager
- PostgreSQL (for `root_db_api`)

## Dependency Installation

### Option A: Install from repo root (recommended)

```powershell
cd "C:\Users\A200315753\Work\FST\fst-editor\fst_data_pipeline-feature-editor-api"
uv venv
.\.venv\Scripts\Activate.ps1
uv sync
```

### Option B: Install per app

#### root_db_api

```powershell
cd "C:\Users\A200315753\Work\FST\fst-editor\fst_data_pipeline-feature-editor-api\fst_data_pipeline\apps\root_db_api"
uv venv
.\.venv\Scripts\Activate.ps1
uv sync
```

#### mta_manage_system

```powershell
cd "C:\Users\A200315753\Work\FST\fst-editor\fst_data_pipeline-feature-editor-api\fst_data_pipeline\apps\mta_manage_system"
uv venv
.\.venv\Scripts\Activate.ps1
uv sync
```

## Database Configuration

### 1) root_db_api

`root_db_api` reads DB settings from environment variables in:

- `fst_data_pipeline/apps/root_db_api/src/db/connection.py`

Required variables:

- `DB_USER`
- `DB_PASSWORD`
- `DB_BASE_URL`

The runtime DB URL is assembled as:

- `postgresql://{DB_USER}:{DB_PASSWORD}@{DB_BASE_URL}`

Example (`PowerShell`):

```powershell
$env:DB_USER = "admin"
$env:DB_PASSWORD = "your_password"
$env:DB_BASE_URL = "127.0.0.1:5432/fsq_dev"
```

You can also see a container run example in:

- `start.sh`

### 2) mta_manage_system

`mta_manage_system` reads DB from:

- `fst_data_pipeline/apps/mta_manage_system/config.py`

Key variable:

- `DATABASE_URL`

Example:

```powershell
$env:DATABASE_URL = "postgresql://username:password@127.0.0.1:5432/dbname"
```

`config.py` will load env files automatically in this order:

- `.env`
- `.env.<FLASK_ENV>`
- `.env.local`

## Run (quick)

### root_db_api

```powershell
cd "C:\Users\A200315753\Work\FST\fst-editor\fst_data_pipeline-feature-editor-api\fst_data_pipeline\apps\root_db_api"
python src\app.py
```

Default API endpoint:

- `http://localhost:5232/api`

### mta_manage_system

```powershell
cd "C:\Users\A200315753\Work\FST\fst-editor\fst_data_pipeline-feature-editor-api\fst_data_pipeline\apps\mta_manage_system"
python app.py
```

## Notes

- `root_db_api` has a detailed service-level guide in `fst_data_pipeline/apps/root_db_api/README.md`.
- Keep secrets (DB password, OAuth secrets) in environment variables or local `.env` files; do not commit them.