Merge pull request #20 from tribofustack/docs/readme

Docs/readme
tribofustack · May 19, 2024 · d4a4a3e · d4a4a3e
2 parents 65f7111 + 0765839
commit d4a4a3e
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 4 deletions.
diff --git a/assets/arch.png b/assets/arch.png
diff --git a/ms-auth b/ms-auth
diff --git a/readme.md b/readme.md
@@ -5,7 +5,7 @@
    <a href="#-project">Links</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
   <a href="#-technologies">Tecnologies</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
   <a href="#-running">Running</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#-license">License</a>
+  <a href="#-diagram">Arch Diagram</a>
 </p>
 
 <p align="center">
@@ -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](<https://kubernetes.io/>)
 
 
+## 🟢 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](<https://github.com/tribofustack/ms-auth.git>)
+  - [ms-checkin](<https://github.com/tribofustack/ms-checkin.git>)
+  - [ms-checkout](<https://github.com/tribofustack/ms-checkout.git>)
+  - [ms-financial](<https://github.com/tribofustack/ms-financial.git>)
+
+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
 
 <div align="center">
-  <h2>Architecture</h2>
   <img src="./assets/arch.png" alt="ER Diagram" />
 </div>
+32 −0		.github/workflows/build.yaml
+2 −1		index.ts
+49 −0		jest.config.ts
+7 −3		package.json
+14 −0		sonar-project.properties
+12 −7		src/DB/connectionMongoose.ts
+0 −13		src/utils/TokenGenerator.ts
+77 −0		tests/DB/connection.spec.ts
+49 −0		tests/auth.server.spec.ts
+75 −0		tests/controller/auth.controller.spec.ts
+53 −0		tests/services/auth.service.spec.ts
+28 −0		tests/utils/helper.spec.ts
+38 −0		tests/utils/tokenGenerator.spec.ts