aendari/universallanguageapp-backend repository overview

⁠Repository Overview

⁠A.E.L.L.A. — Backend

This container runs the A.E.L.L.A. backend: a Python API server that provides instant pronunciation, smart definitions, Anki flashcard export, and Obsidian notes integration for the A.E.L.L.A. language-learning companion.

⁠✨ Features

• REST/JSON API for pronunciation, definitions, and flashcard export
• Anki deck export (CSV / .apkg via API)
• Obsidian notes export/sync endpoints
• Configurable database and cache (Postgres, Redis)
• Authentication / API key support
• Healthcheck endpoint for orchestration

⁠🏷️ Supported Tags

• latest — stable release
• python-3.11-slim — Debian-based runtime
• alpine — minimal runtime (if published)

(Adjust tags to match your release scheme.)

⁠🚀 Quick Start

docker pull aendari/universallanguageapp-backend:latest

docker run -d \
  --name aella-backend \
  -p 8000:8000 \
  aendari/universallanguageapp-backend:latest

⁠⚙️ Common Environment Variables

• PORT (default: 8000) — internal listening port
• DATABASE_URL — Postgres connection string
• REDIS_URL — Redis connection string
• SECRET_KEY — application secret / signing key
• LOG_LEVEL (default: info)
• SENTRY_DSN — optional error reporting
• ADMIN_API_KEY — optional administrative key

⁠🔌 Exposed Ports

• 8000/tcp — HTTP API

Healthcheck: Point orchestrator to /health or /ready (HTTP) for container health checks.

⁠📄 Example docker-compose Snippet

version: "3.8"
services:
  backend:
    image: aendari/universallanguageapp-backend:latest
    ports:
      - "8000:8000"
    environment:
      - DATABASE_URL=postgres://user:pass@postgres:5432/aella
      - REDIS_URL=redis://redis:6379/0
      - SECRET_KEY=${SECRET_KEY}
    depends_on:
      - postgres
      - redis

  postgres:
    image: postgres:15
    environment:
      - POSTGRES_DB=aella
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=pass

  redis:
    image: redis:7

⁠📈 Scaling & Deployment Notes

• Run behind a reverse proxy (Traefik, Nginx) or load balancer.
• Use managed Postgres/Redis for production or dedicated containers with persistent volumes.
• Run multiple replicas and use external shared storage/backups for durability.

⁠📜 License & Source

• Source: https://github.com/a-endari/A.E.L.L.A⁠
• License: (add license type if not MIT)