SepidZ Business Intelligence Platform – System Design

A comprehensive Business Intelligence (BI) solution for the SepidZ restaurant management ecosystem
Complete architectural documentation using PlantUML – fully editable and live-rendered in VS Code

---

Table of Contents

• Project Overview
• Key Features
• Prerequisites
• VS Code + PlantUML Setup

---

Project Overview

This repository contains the complete system design of SepidZ Business Intelligence (BI) platform, developed as the final project for the Software Engineering course under supervision of Dr. Hojjat Fazayeli (Academic Year 1404-1405 / 2025-2026).

The system transforms raw transactional data from SepidZ POS into actionable insights using:

• Kimball dimensional modeling
• CRISP-DM methodology
• Modern ETL pipelines (FastAPI, React, PostgreSQL, Redis, Docker, AWS)

All diagrams are created with PlantUML for maximum maintainability and collaboration.

---

Features

• 4 Core UML diagrams (Sequence, Component, Deployment, Sprint Plan)
• 9 Bonus diagrams for extra credit:
  • 3 Collaboration Diagrams
  • 3 State Machine Diagrams
  • 3 Activity Diagrams
• Live preview in VS Code
• Automatic PNG/SVG export on save
• Fully version-controlled

---

Prerequisites

Tool	Minimum Version	Download / Install Command
VS Code	Latest	https://code.visualstudio.com/
Git	2.30+	winget install --id Git.Git -e --source winget
Java JRE/JDK	11+	winget install Oracle.JDK.21 or Adoptium Temurin
Graphviz	2.38+	winget install Graphviz.Graphviz

---

VS Code + PlantUML Setup

1. Install PlantUML Extension

code --install-extension jebbs.plantuml

2. Recommended Settings (add to settings.json) { "plantuml.render": "PlantUMLServer", "plantuml.server": "https://www.plantuml.com/plantuml", "plantuml.exportFormat": "png", "plantuml.exportOutDir": "diagrams-export", "plantuml.exportSubFolder": false, "plantuml.autoExportOnSave": true }

3. Optional: Local PlantUML Server (for offline work) java -jar plantuml.jar -http 8080