Update README.md

Author: singhsayan

README.md

@@ -6,53 +6,89 @@ This project demonstrates a complete monitoring-enabled deployment pipeline for
 
 ## ✅ Project Highlights
 
-- 🟢 **Node.js Application**: Lightweight backend service written in Node.js, exposing basic endpoints for monitoring.
-- 🐳 **Dockerized**: Fully containerized using Docker with a production-ready `Dockerfile`.
-- ☸️ **Kubernetes Native**: Application and observability stack deployed via Kubernetes manifests, including Deployments, Services, and Persistent Volumes.
-- 📈 **Prometheus Integration**: Configured to scrape metrics from the application with a custom `prometheus.yml`.
-- 📊 **Grafana Dashboards**: Set up to visualize key application and cluster metrics with persistent storage.
-- 🤖 **CI/CD with GitHub Actions**: Automated pipeline builds and pushes Docker images to Docker Hub on every commit to `main`.
-- 🧪 **Minikube Deployment**: Manual deployment workflow using Minikube for local development and testing.
+* 🟢 **Node.js Application**: Lightweight backend service written in Node.js, exposing basic endpoints for monitoring.
+* 🐳 **Dockerized**: Fully containerized using Docker with a production-ready `Dockerfile`.
+* ☘️ **Kubernetes Native**: Application and observability stack deployed via Kubernetes manifests, including Deployments, Services, and Persistent Volumes.
+* 📊 **Prometheus Integration**: Configured to scrape metrics from the application with a custom `prometheus.yml`.
+* 📈 **Grafana Dashboards**: Set up to visualize key application and cluster metrics with persistent storage.
+* 🤖 **CI/CD with GitHub Actions**: Automated pipeline builds and pushes Docker images to Docker Hub on every commit to `main`.
+* 🧰 **Minikube Deployment**: Manual deployment workflow using Minikube for local development and testing.
 
 ---
 
 ## ⚙️ Technologies Used
 
-- **Node.js**, **Express**
-- **Docker**, **Docker Hub**
-- **Kubernetes**, **Minikube**
-- **Prometheus**, **Grafana**
-- **GitHub Actions (CI/CD)**
-- **YAML**
+* **Node.js**, **Express**
+* **Docker**, **Docker Hub**
+* **Kubernetes**, **Minikube**
+* **Prometheus**, **Grafana**
+* **GitHub Actions (CI/CD)**
+* **YAML**
 
 ---
 
-<h3>✅ GitHub Actions Success</h3>
-<p>Shows multiple successful workflow runs:</p>
-<img src="screenshots/github-actions-success.png" alt="GitHub Actions Success" width="600"/>
-<br/><br/>
+### ✅ GitHub Actions Success
 
-<h3>📦 Node.js App Running (Browser Output)</h3>
-<img src="screenshots/Node.js-app-running-on-browser.png" alt="Node.js App Running" width="600"/>
-<br/><br/>
+Shows multiple successful workflow runs:
 
-<h3>📈 Prometheus - Targets Page</h3>
-<img src="screenshots/prometheus-targets-page.png" alt="Prometheus Targets" width="600"/>
-<br/><br/>
+![GitHub Actions Success](screenshots/github-actions-success.png)
 
-<h3>📊 Grafana - Custom Dashboard</h3>
-<img src="screenshots/Grafana-Dashboard.png" alt="Grafana Dashboard" width="600"/>
-<br/><br/>
+### 📦 Node.js App Running (Browser Output)
 
-<h3>🔌 Prometheus Service - Terminal Output</h3>
-<img src="screenshots/prometheus-service-terminal.png" alt="Prometheus Terminal" width="600"/>
-<br/><br/>
+![Node.js App Running](screenshots/Node.js-app-running-on-browser.png)
 
-<h3>📊 Grafana Service - Terminal Output</h3>
-<img src="screenshots/grafana-service-terminal.png" alt="Grafana Terminal" width="600"/>
-<br/><br/>
+### 📈 Prometheus - Targets Page
 
+![Prometheus Targets](screenshots/prometheus-targets-page.png)
 
+### 📊 Grafana - Custom Dashboard
+
+![Grafana Dashboard](screenshots/Grafana-Dashboard.png)
+
+### 🔌 Prometheus Service - Terminal Output
+
+![Prometheus Terminal](screenshots/prometheus-service-terminal.png)
+
+### 📊 Grafana Service - Terminal Output
+
+![Grafana Terminal](screenshots/grafana-service-terminal.png)
+
+---
+
+## 🔄 GitHub Actions CI/CD Setup
+
+This project uses GitHub Actions to automatically build and push Docker images to Docker Hub when you push code to the `main` branch.
+
+### 🥉 How It Works:
+
+1. **Docker Build & Push**
+
+   * The workflow defined in `.github/workflows/ci-cd.yml` runs on each `main` branch push.
+   * It builds the Docker image and pushes it to Docker Hub using secrets for authentication.
+
+2. **Secrets Required**
+
+   * Add the following secrets to your GitHub repository:
+
+     | Secret Name       | Description                       |
+     | ----------------- | --------------------------------- |
+     | `DOCKER_USERNAME` | Your Docker Hub username          |
+     | `DOCKER_PASSWORD` | Your Docker Hub password or token |
+
+3. **Trigger**
+
+   * Push your code to the `main` branch. GitHub Actions will:
+
+     * Checkout code
+     * Set up Docker Buildx
+     * Login to Docker Hub
+     * Build & push image to Docker Hub
+     * Tag format: `DOCKER_USERNAME/my-first-docker-image:latest`
+
+4. **CI Only**
+
+   * The workflow automates **CI** — i.e., build and push to Docker Hub.
+   * You can then manually pull & deploy using Kubernetes (**CD step**) via Minikube.
 
 ---
 
@@ -64,20 +100,31 @@ Deploy the application and observability stack locally using Minikube:
 
 ```bash
 minikube start
+```
 
-# Create namespaces for Prometheus and Grafana
+### 2. Create Namespaces
 
+```bash
 kubectl create namespace prometheus
 kubectl create namespace grafana
+```
 
-# Apply all Kubernetes manifests
+### 3. Apply All Kubernetes Manifests
 
+```bash
 kubectl apply -f k8s/
 kubectl apply -f k8s/prometheus
 kubectl apply -f k8s/grafana
+```
 
-# Expose services via Minikube
+### 4. Expose Services via Minikube
 
+```bash
 minikube service grafana
 minikube service prometheus-service -n prometheus
 minikube service node-service
+```
+
+---
+
+Feel free to ⭐ the repo if you found it helpful or fork it to expand and build upon it!