Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 4.35 KB

HELP.md

File metadata and controls

60 lines (43 loc) · 4.35 KB

Getting Started

Reference Documentation

For further reference, please consider the following sections:

Guides

The following guides illustrate how to use some features concretely:

Additional Links

These additional references should also help you:

Testcontainers support

This project uses Testcontainers at development time.

Testcontainers has been configured to use the following Docker images:

Please review the tags of the used images and set them to the same as you're running in production.

graph TD;
  A[Web Client] --> B[API Gateway]
  B --> C[Authentication Service]
  B --> D[Inventory Service]
  B --> E[Production Service]
  B --> F[Shipping Service]
  B --> G[Reporting Service]
Loading
  • Web Client: This is the user interface that shop floor personnel will interact with to access the ERM system. It will likely be a web-based application that communicates with the backend services through the API Gateway.
  • API Gateway: The API Gateway serves as the single entry point for the client applications. It is responsible for routing requests to the appropriate microservices, handling authentication, and potentially performing some basic request/response transformations.
  • Authentication Service: This service is responsible for handling user authentication and authorization. It will manage user accounts, roles, and permissions, ensuring that only authorized personnel can access and modify the system's data.
  • Inventory Service: The Inventory Service is the central hub for all inventory-related operations. It handles tasks such as receiving new inventory, tracking stock levels, managing material consumption, and providing inventory reporting.
  • Production Service: The Production Service is responsible for logging and tracking the manufacturing process. This includes creating and managing work orders, recording production steps, capturing quality control data, and providing production analytics.
  • Shipping Service: The Shipping Service manages the logistics of shipping finished products. It handles tasks like integrating with shipping carriers, recording shipment details, generating shipping documentation, and providing shipment tracking and reporting.
  • Reporting Service: The Reporting Service aggregates data from the other microservices to provide advanced reporting and analytics capabilities. This will include customizable dashboards, historical trend analyses, and predictive forecasting.
  • Message Broker: The Message Broker, such as RabbitMQ or Apache Kafka, enables asynchronous communication between the microservices. It allows the services to publish and subscribe to events, ensuring data consistency and reducing the need for tight coupling.
  • Database Cluster: The database cluster stores all the critical data for the ERM system, including inventory, production, shipping, and user information. It likely consists of a relational database management system, such as PostgreSQL or MySQL, with appropriate replication and sharding to ensure scalability and high availability.