How leqo-framework/qc-atlas-api works
Project type and purpose
• This is a monorepo hosting a Java-based backend service for the QC-Atlas project. It consists of two Maven modules:
• org.planqk.atlas.core – the domain-centric library (entities, repositories, services, Liquibase changelogs, integration utilities)
• org.planqk.atlas.web – a Spring Boot REST API layer exposing the core services via HTTP (controllers, DTOs, configuration, Swagger/OpenAPI)
• Purpose: to provide a RESTful catalog of quantum-computing artifacts (algorithms, implementations, compute resources, TOSCA templates, etc.) backed by PostgreSQL and optional cloud storage.
File structure
• Top-level directories:
• .docker, Dockerfile, docker-compose.yml – containerization artifacts
• config, org.planqk.atlas.core, org.planqk.atlas.web – actual code/config
• docs/adr – architectural decision records, docs/dev – developer guides
• Core module: follows the classic layered architecture (model → repository → service → exception/util). Uses Liquibase for DB migrations, JPA/Hibernate, Testcontainers for integration tests, RestTemplate to call external Winery service.
• Web module: Spring Boot app with a package per layer: configuration, controllers (one per domain aggregate), DTOs & link assemblers for hypermedia, exception handlers, utilities (validation, model mapping).
Key insights from README
• Built via Maven, packaged as a Spring Boot JAR/WAR, runnable in Docker.
• Exposes OpenAPI/Swagger UI (build_swagger_ui.yml).
• Integrates with Postgres (JDBC/Hibernate) and optionally external cloud storage.