Skip to content

iKirtesh/shopverse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🛒 ShopVerse – Intelligent Event-Driven E-Commerce Platform

📘 Technical Documentation

This repository contains the official technical documentation for ShopVerse – Intelligent Event-Driven E-Commerce Platform, a production-grade, microservices-based e-commerce system designed using real-world backend, security, and scalability principles.

The documentation is maintained as a separate, first-class project to reflect industry-standard engineering practices.

🌐 Live Documentation:
👉 https://shopverse-docs.vercel.app


🧠 What is ShopVerse?

ShopVerse is a full-stack, event-driven e-commerce platform featuring:

  • Microservices architecture
  • API Gateway–based centralized security
  • JWT authentication & Role-Based Access Control (RBAC)
  • Apache Kafka–based event-driven workflows
  • Payment processing, notifications, analytics, and recommendations
  • Clean separation of backend, frontend, and documentation repositories

📦 ShopVerse Repository Structure

ShopVerse is intentionally split into multiple repositories, mirroring how real production teams work.


ShopVerse Ecosystem
│
├── 🔧 shopverse-backend
│   └── Microservices, Kafka, Security, Payments
│
├── 🎨 shopverse-frontend
│   └── User Interface (React / Next.js)
│
└── 📘 shopverse-docs  ← (This Repository)
└── Architecture, APIs, Security & System Design

🔗 Repository Links


📚 What This Documentation Covers

This documentation provides deep technical insight into:

  • 🏗️ System Architecture

    • Overall platform architecture
    • Microservices communication
    • Event-driven design using Kafka
  • 🔐 Security

    • JWT authentication flow
    • API Gateway security
    • Role-Based Access Control (RBAC)
    • Secure secret management
  • 🧩 Microservices

    • Auth, User, Product, Order, Payment
    • Notification, Analytics, Recommendation
  • 📡 Messaging

    • Kafka topics & events
    • Event schema design
    • Idempotency strategy
  • 🌐 API Reference

    • Auth, User, Product, Order
    • Payment, Notification, Analytics, Recommendation

This repository is designed to be:

  • 📖 Easy to read
  • 🧠 Easy to explain in interviews
  • 🎯 Strong for system design discussions
  • 💼 Impressive for recruiters

🛠️ Tech Stack (Documentation)

  • Docusaurus – Static documentation framework
  • Markdown / MDX – Content authoring
  • Mermaid – Architecture & sequence diagrams
  • React – UI components
  • Vercel – Hosting & CI/CD
  • GitHub – Version control

🚀 Local Setup

Install dependencies

npm install

Run locally

npm run start

🏗️ Build for Production

npm run build
  • Generates static files in build/
  • Ready for deployment on any static hosting platform

🌍 Deployment

This documentation is deployed using Vercel with GitHub integration.

Vercel Configuration

Setting Value
Framework Preset Other
Install Command npm install
Build Command npm run build
Output Directory build

Every push to main triggers an automatic redeploy.


🧠 Interview One-Liner

“ShopVerse is an intelligent, event-driven e-commerce platform built using microservices, Kafka, and centralized JWT-based security, with complete production-grade documentation maintained separately using Docusaurus.”


👥 Project Team

👨‍💻 Kirtesh Admute

👨‍💻 Sangam Mundhe


⭐ Why This Repository Matters

Most candidates:

  • Don’t document systems
  • Mix docs with code
  • Struggle to explain architecture clearly

This repository demonstrates:

  • Strong system thinking
  • Clear technical communication
  • Production-ready mindset
  • Ownership beyond just coding

© 2026 ShopVerse – Intelligent Event-Driven E-Commerce Platform Built with ❤️ using Docusaurus

About

This repository contains the official technical documentation for ShopVerse – Intelligent Event-Driven E-Commerce Platform, a production-grade, microservices-based e-commerce system designed using real-world backend, security, and scalability principles.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors