From 5465811781ae0035c45528d1139b3e1fa0a4dc99 Mon Sep 17 00:00:00 2001 From: ryan <ryannganga13325@gmail.com> Date: Sat, 15 Mar 2025 16:53:18 +0300 Subject: [PATCH] docs(README): update readme with steps of docker deployment. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index fc5ef3a..f0ebd00 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,23 @@ flowchart LR items -->|item_id| item_properties properties -->|property_id| item_properties ``` +## **Docker Deployment** + +### **Prerequisites** +- Docker installed on your system +- Docker Compose (usually included with Docker Desktop) + +### **Running with Docker** +1. Clone the repository: + ```bash + git clone https://forge.ftt.gmbh/ryanmwangi/Compware.git + cd compareware + ``` +2. Start the container: + ```bash + docker-compose up -d + ``` +3. Access the application at: [http://localhost:3000](http://localhost:3000) ### **Collaboration** We welcome contributions! Here’s how you can help: