How erlendromo/forsete-atr works
Project type and purpose
• This is a Go-based REST API microservice called “forsete-atr” that implements a Handwritten Text Recognition (HTR) pipeline.
• It is containerized with Docker (CPU/GPU variants), orchestrated via Docker Compose, and its infrastructure is provisioned via Terraform.
• It exposes a versioned API (/forsete-atr/v1/…) with Swagger UI docs.
File structure
• Top-level:
• main.go, go.mod, go.sum – entry point & dependency manifest
• docker/, docker-compose.yaml – Dockerfiles and Compose definitions for CPU/GPU deployments
• backend/ – Terraform configs for provisioning cloud resources (e.g., Openstack instances, networking)
• scripts/ – helper scripts to bootstrap environments on Linux/Mac/Windows
• CI/CD: .github/workflows/ (build, test, terraform-destroy) and .github/actions/ (format, test_go, validate)
• docs/ – Swagger JSON/YAML and Go doc stub
• src/ directory follows a layered structure:
• src/api/ – HTTP adapters (handlers, middleware, router)
• src/cmd/rest/ – CLI entry for REST server
• src/config/ – environment and config loading
• src/domain/ – core business logic:
– htrflow (pipeline orchestration)
– image (image processing)
– modelstore (model persistence & retrieval)
– pipeline/step (individual pipeline stages)
• src/util/ – shared utilities (error handling, logging, timing)
README for additional insights
• Deployment targets: CPU vs. GPU containers
• Environment variables and ports must match Terraform (API_PORT = application_port)
• Usage patterns: Makefile targets (composecpu, composegpu, attach, composedown)
• API discovery via Swagger UI