From a7c11477afc1d39e4d85a911f38383f2676ef2c1 Mon Sep 17 00:00:00 2001 From: Benjamin Loh Date: Tue, 7 Nov 2023 20:41:06 +0800 Subject: [PATCH] updated readme updated readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5a6e2f9..b14b94c 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,23 @@ docker-compose up ``` ### Running Backend & Frontend Separately (Docker + Kubernetes) + +### Prerequisites + +Before you begin, make sure you have: + +- A Kubernetes cluster up and running. +- `kubectl` installed and configured to communicate with your cluster. +- Proper permissions to create Deployments, Services, Persistent Volumes, and other Kubernetes resources. + +### Overview of Components + +- `frontend_deployment.yaml`: Deployment for the SafeShare frontend. +- `frontend_service.yaml`: Service exposing the SafeShare frontend. +- `backend_deployment.yaml`: Deployment for the SafeShare backend. +- `backend_service.yaml`: Service exposing the SafeShare backend. +- `redis_deployment.yaml`: Setup for Redis with persistent storage. + ```bash # Run frontend using docker-compose docker compose -f docker-compose-frontend.yml up -d