How miguelsmuller/lumi-invoice-challenge works
Main Components
• Frontend: Represent this with the “Invoice Front” service (submodule: lumi-front), which handles the user interface for listing and managing transactions.
• Backend: Represent the “Invoice Back” service (submodule: lumi-back) that interfaces with the Invoice API and implements business logic.
• Database: Include the PostgreSQL service (named lumi-db) defined in docker-compose.yml, which serves as the system’s data store.
• Extraction Module: Add a component (from the lumi-extraction submodule) likely responsible for parsing, extracting, and managing invoice-related data.
• Supporting Infrastructure: Mark the Docker environment that orchestrates these containers and any helper scripts (Makefile for starting services).
Relationships and Interactions
• That the Invoice Back service interacts with the PostgreSQL database (with connection details such as host, port, and credentials as set in docker-compose).
• If applicable, show the extraction service interacting with the Invoice Back service or handling the data before it gets stored or displayed.
• Optionally, highlight that the Makefile serves as the entry point for developers, triggering docker-compose commands that start all these containers.
Architectural Patterns
• This project follows a microservices or containerized architecture, where multiple standalone services (frontend, backend, database) are deployed via Docker.
• The separation of concerns is clear—each service is encapsulated in its own submodule and container.
• The use of a monorepo with Git submodules emphasizes centralized version control and coordinated development across project parts.
Technologies and Tools
• Docker & Docker Compose: Emphasize container orchestration and service isolation.
• PostgreSQL: Clearly label it for the database service.
• Git Submodules: Note the project uses submodules for lumi-back, lumi-front, and lumi-extraction, which helps maintain clean boundaries between the codebases.
• Makefile: Show its role in streamlining service startups and common development tasks.