Setup Instructions

Prerequisites

• Python 3.12+
• uv package manager
• Docker (optional, for containerized deployment)

Local Development Setup

1. Clone the Repository

git clone https://github.com/GIcsei/BAB.git
cd BAB

2. Install Dependencies

pip install uv
uv sync --frozen --group dev

3. Configure Environment

Copy the example environment file and customize:

cp .env.example .env

Windows PowerShell:

Copy-Item .env.example .env

.env is git-ignored; keep template defaults in .env.example and store real secrets only in local/runtime env files.

Required environment variables:

Variable	Description	Default
APP_USER_DATA_DIR	Directory for user data storage	/var/app/user_data
APP_JOB_HOUR	Scheduled job hour (0-23)	18
APP_JOB_MINUTE	Scheduled job minute (0-59)	0
FIRESTORE_CREDENTIALS	Path to Firebase service account JSON	—
LOG_LEVEL	Logging level	INFO
LOG_FILE	Log file path (empty for stdout)	—
LOG_JSON	Enable JSON-formatted logs	false
LOG_ROTATION_MAX_BYTES	Max size per rotated log file when LOG_FILE is set	10485760
LOG_ROTATION_BACKUP_COUNT	Rotated log file count when LOG_FILE is set	5
APP_UNREGISTER_DELETION_DAYS	Delay before unregister deletion worker removes account data	60
APP_ALLOW_UNSAFE_DESERIALIZE	Allow pickle deserialization	false
SELENIUM_DOWNLOADS_DIR	Selenium download directory	—
SELENIUM_REMOTE_URL	Selenium Grid endpoint for WebDriver and startup probe	http://selenium:4444
LOCAL_DOWNLOADS_DIR	Local download directory	—
FIREBASE_API_KEY	Firebase Web API key (required for Firebase auth flows)	—

4. Run the Application

# Development mode with auto-reload
uv run uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

Or use the dev script:

./scripts/dev.sh

5. Verify

curl http://localhost:8000/health

Code Quality Tools

Linting

uv run ruff check app tests
uv run black --check app tests

Formatting

uv run black app tests
uv run ruff check --fix app tests

Or use the script:

./scripts/format.sh

Type Checking

uv run mypy app

Security Audit

uv run pip-audit