From 529914dd60c1c60ebb5193f21708d1c42e46690f Mon Sep 17 00:00:00 2001 From: John Patrick Teruel Date: Fri, 24 Apr 2026 21:43:45 +0800 Subject: [PATCH] Add quickstart instructions to README top - 3-step quick start (5 minutes) at the very top - Links to detailed documentation (DEMO, EXPLAIN, QUICKSTART) - Clear copy-paste commands for immediate getting started - Emoji visual hierarchy for quick scanning Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index d53bf11..698db2f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ +# 🚀 PayGuard Fraud Detection System - Quick Start + +## Get Started in 3 Steps (5 minutes) + +```bash +# 1️⃣ Start all Docker services +docker compose up -d --build + +# 2️⃣ Start the fraud detection consumer +cd consumer && python3 pipeline.py + +# 3️⃣ Open the frontend +# Visit http://localhost:3000 in your browser +``` + +**That's it!** Now submit transactions and watch fraud detection work in real-time. + +--- + +### 📚 Full Documentation + +- **[DEMO.md](./DEMO.md)** - Complete step-by-step demonstration guide (10 minutes) +- **[EXPLAIN.md](./EXPLAIN.md)** - System architecture with Mermaid diagrams +- **[QUICKSTART.md](./QUICKSTART.md)** - Detailed setup guide +- **[FRAUD_DETECTION_DEMO.md](./FRAUD_DETECTION_DEMO.md)** - Fraud scenarios and examples + +--- + +## System Architecture Overview + Here's the full end-to-end flowchart of the PayGuard system. The flow follows this logic: Transaction initiated → passes through JWT authentication to verify the caller's identity.