https://github.com/deepak748030/savana
Scalable and modular ecommerce backend built with Node.js, Express, MongoDB, Swagger, Docker, and Kubernetes — designed for performance, security, and maintainability.
https://github.com/deepak748030/savana
api-documentation backend docker ecommerce express grafana jwt-authentication kubernetes microservices mongodb multer nginx nodejs prometheus rest-api swagger
Last synced: 3 months ago
JSON representation
Scalable and modular ecommerce backend built with Node.js, Express, MongoDB, Swagger, Docker, and Kubernetes — designed for performance, security, and maintainability.
- Host: GitHub
- URL: https://github.com/deepak748030/savana
- Owner: deepak748030
- Created: 2025-06-17T20:37:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-22T05:45:33.000Z (7 months ago)
- Last Synced: 2026-04-05T22:35:25.501Z (3 months ago)
- Topics: api-documentation, backend, docker, ecommerce, express, grafana, jwt-authentication, kubernetes, microservices, mongodb, multer, nginx, nodejs, prometheus, rest-api, swagger
- Language: JavaScript
- Homepage: https://savana-server.vercel.app
- Size: 2.46 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Savana Ecommerce Backend
🛒 Full Production-Ready Backend with Kubernetes Support and Swagger
Live Swagger API: http://your-domain.com/api-docs
---
## 📖 Table of Contents
- [🌟 Features](#-features)
- [🛠️ Technology Stack](#️-technology-stack)
- [🚀 Getting Started](#-getting-started)
- [⚙️ Kubernetes Setup](#%EF%B8%8F-kubernetes-setup)
- [📁 Project Structure](#-project-structure)
- [🌐 Deployment](#-deployment)
- [🧪 API Testing](#-api-testing)
- [📄 License](#-license)
- [👨💻 Author](#-author)
---
## 🌟 Features
- ⚙️ Modular Express Backend (routes, controllers, services)
- 🧩 Category & Product CRUD APIs
- 📤 Image Upload via Multer
- 🔍 Product Search and Filter by Category
- 🌍 MongoDB Integration (external URI)
- 📚 Swagger API Docs (`/api-docs`)
- 📦 Prometheus Metrics Ready (for Grafana)
- 🧱 Dockerized with Node 22 Alpine
- ☸️ Kubernetes with Ingress & NGINX
- 📂 Public static file support via `/uploads`
---
## 🛠️ Technology Stack
- **Node.js & Express.js** – Backend framework
- **MongoDB** – No internal DB pod, external URI-based
- **Multer** – File handling
- **Swagger** – Auto API documentation
- **Docker** – Containerization
- **Kubernetes** – Orchestration & scaling
- **NGINX + Ingress** – Domain + SSL route config
---
## 🚀 Getting Started
### 📦 Prerequisites
- Node.js >= 16
- Docker & Kubernetes (Minikube or cluster)
- MongoDB Atlas URI
### 🔧 Setup Locally
```bash
git clone https://github.com/deepak748030/savana.git
cd savana
npm install
cp .env.exports.js .env # Rename and fill your Mongo URI
npm run dev
````
Visit Swagger: [http://localhost:5000/api-docs](http://localhost:5000/api-docs)
---
## ⚙️ Kubernetes Setup
### ✅ Files
* `k8s/deployment.yaml`
* `k8s/service.yaml`
* `k8s/ingress.yaml`
* `k8s/nginx-ingress.yaml`
### 🧠 Commands
```bash
kubectl apply -f k8s/deployment.yaml
kubectl apply -f k8s/service.yaml
kubectl apply -f k8s/nginx-ingress.yaml
kubectl apply -f k8s/ingress.yaml
```
> Ensure `Ingress` is enabled in Minikube:
```bash
minikube addons enable ingress
```
---
## 📁 Project Structure
```
.
├── src/
│ ├── config/ # DB and env setup
│ ├── controllers/ # Logic for API endpoints
│ ├── models/ # Mongoose models
│ ├── routes/ # API routes
│ ├── uploads/ # Image uploads
│ ├── utils/ # Helpers
│ ├── swagger/ # Swagger config
│ └── app.js # Express app config
├── server.js # Server entry point
├── k8s/ # Kubernetes manifests
├── Dockerfile # Docker container config
├── .env.exports.js # Sample env file
├── package.json
└── README.md
```
---
## 🌐 Deployment
### 🐳 Docker Build & Push
```bash
docker build -t yourdockerhub/savana-backend .
docker push yourdockerhub/savana-backend
```
### ☸️ Deploy to Kubernetes
```bash
kubectl apply -f k8s/
```
Access via: `http:///api-docs` after setting ingress.
---
## 🧪 API Testing
* **Docs:** `GET /api-docs`
* **File Uploads:** `POST /api/upload`
* **Protected Routes:** Use `Authorization: Bearer `
* **Metrics (for Prometheus):** `GET /metrics`
---
## 📄 License
MIT License
```
© 2025 Deepak Kushwah
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction...
```
---
## 👨💻 Author
**Deepak Kushwah**
Full Stack Developer (MERN + DevOps)
* 📧 [deepak748930@gmail.com](mailto:deepak748930@gmail.com)
* 🔗 [LinkedIn](https://linkedin.com/in/deepak-kushwah)
* 💻 [GitHub](https://github.com/deepak748030)
> ⭐ Star this repo if you found it useful!
> 🔗 [https://github.com/deepak748030/savana](https://github.com/deepak748030/savana)