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 <[email protected]>
This commit is contained in:
John Patrick TeruelandCopilot committed 2026-04-24 21:43:45 +08:00
1 parent 215c15a494
commit 529914dd60
1 file changed
+30
+30
View File
@@ -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: 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. Transaction initiated → passes through JWT authentication to verify the caller's identity.