From bc04be4de99c0b4e86196a1e5e0fbc14f8d8b499 Mon Sep 17 00:00:00 2001
From: Yuval Bubnovsky <93248620+YuvalBubnovsky@users.noreply.github.com>
Date: Sun, 29 Sep 2024 20:26:17 +0300
Subject: [PATCH] docs: Added docker support documentation (#465)

---
 .../running-things-locally/docker-support.md  | 93 +++++++++++++++++++
 1 file changed, 93 insertions(+)
 create mode 100644 docs/contributing-to-keyshade/running-things-locally/docker-support.md

diff --git a/docs/contributing-to-keyshade/running-things-locally/docker-support.md b/docs/contributing-to-keyshade/running-things-locally/docker-support.md
new file mode 100644
index 00000000..21664af1
--- /dev/null
+++ b/docs/contributing-to-keyshade/running-things-locally/docker-support.md
@@ -0,0 +1,93 @@
+---
+description: Instructions on how to build & run each part of keyshade using docker
+---
+
+# Docker Support
+
+This document provides instructions on how to build and run our applications using Docker.
+
+## Prerequisites
+
+- Docker must be installed on your system.
+
+## Available Applications
+
+We have Docker support for the following applications:
+
+1. Web Application
+2. API
+3. Platform
+
+## Building and Running Applications
+
+### Environment Variables
+
+All applications use environment variables from a `.env` file. Ensure this file is present in your project root directory with the necessary configurations.
+
+### Starting and Stopping Services
+
+For a quick way to start up all containers(Web, API and Platform) you can simply run:
+
+```bash
+docker compose up -d
+```
+
+To stop and remove all services:
+
+```bash
+docker compose down
+```
+
+### Web Application
+
+To build the web application:
+
+```bash
+pnpm docker:build:web
+```
+
+To run the web application:
+
+```bash
+pnpm docker:run:web
+```
+
+### API
+
+To build the API:
+
+```bash
+pnpm docker:build:api
+```
+
+To run the API:
+
+```bash
+pnpm docker:run:api
+```
+
+### Platform
+
+To build the platform:
+
+```bash
+pnpm docker:build:platform
+```
+
+To run the platform:
+
+```bash
+pnpm docker:run:platform
+```
+
+## Port Usage
+
+The applications use the following ports by default:
+
+- Web Application: 3000
+- API: 4200
+- Platform: 3025
+
+Ensure these ports are available on your system. If you need to use different ports, you can modify the port mappings in the `package.json` file locally.
+
+For more detailed information about Docker usage, refer to the official Docker documentation.