diff --git a/assets/arch.png b/assets/arch.png index 951601f..2a41820 100644 Binary files a/assets/arch.png and b/assets/arch.png differ diff --git a/ms-auth b/ms-auth index 1283670..a7c3c04 160000 --- a/ms-auth +++ b/ms-auth @@ -1 +1 @@ -Subproject commit 1283670a1f534f34de91bb7b193d134da241474f +Subproject commit a7c3c047ece760aa8f5d38de5f751507b1c45786 diff --git a/readme.md b/readme.md index a3d5a35..71bf6ee 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,7 @@ Links   |    Tecnologies   |    Running   |    - License + Arch Diagram

@@ -19,6 +19,11 @@ Orderly is a cutting-edge web system designed to streamline operations for restaurant and food businesses (RMS). It draws from the principles of **Domain-Driven Design (DDD)** and **Architectural Concepts** to ensure scalability, maintainability, and a robust integration capability. +## 🔗 Links + +- [Demonstration Video]() +- [Postman Public Collection](https://documenter.getpostman.com/view/13574011/2s9YsM8WDL) + ## ✨ Technologies This project was built using the following technologies and architectural concepts: @@ -27,13 +32,39 @@ This project was built using the following technologies and architectural concep - [NGINX](https://www.nginx.com/) - [Docker](https://www.docker.com/) - [PostgreSQL](https://www.postgresql.org/) -- [Redis](https://redis.io/) +- [RabbitMQ](https://rabbitmq.com/) - [Kubernetes]() +## 🟢 Running + +Prerequisites: Ensure you have `docker`, `node>=18.16.0` & `npm>=9.5.1` installed. + +1. Clone this project: + +```sh +git clone https://github.com/tribofustack/orderly-api-gateway.git +``` + +2. Configure submodules: + - [ms-auth]() + - [ms-checkin]() + - [ms-checkout]() + - [ms-financial]() + +3. Start the application: + +```sh +docker compose up +``` + +This will launch the application at port `80`. + +Once it's up, the Swagger documentation can be accessed at `http://localhost:80/`. + +## 📌 Architecture Diagram

-

Architecture

ER Diagram