Skip to content

README.md

Latest commit

 

History

History
145 lines (105 loc) · 4.57 KB

README.md

File metadata and controls

145 lines (105 loc) · 4.57 KB

🛡️ NetGuardian AI - Insider Threat Detection Dashboard

Kenya Flag React TypeScript Tailwind

🎯 Overview

NetGuardian AI is a comprehensive cybersecurity dashboard designed for insider threat detection, built specifically for the Kenyan market. It features AI-powered threat analysis, real-time monitoring, and integration with Kenya's National Computer and Cybercrime Coordination Committee (NC4).

✨ Key Features

  • 🤖 AI-Powered Threat Detection - Machine learning-based behavioral analysis
  • 📊 Real-time Monitoring - Live threat alerts and user activity tracking
  • 📁 File Analysis - Automated scanning with risk scoring
  • 👥 User Monitoring - Behavioral pattern detection
  • 📡 NC4 Integration - Compliance reporting for Kenyan regulations
  • 🇰🇪 Kenya-Focused - Local case studies, KES currency, Kenyan flag colors
  • 🎨 Modern UI - Glass morphism design with dark theme and cyan accents
  • 📱 Responsive - Works on desktop, tablet, and mobile devices

🚀 Quick Start

Installation

# Install dependencies
pnpm install

# Start development server
pnpm dev

# Open http://localhost:5173 in your browser

👉 For detailed setup instructions, see LOCAL_SETUP.md

📱 Application Screens

  1. Login Page - Secure authentication
  2. Registration - New user sign-up
  3. Dashboard - Overview with live threat alerts
  4. File Analysis - Upload and scan files
  5. Scan Results - Detailed analysis history
  6. User Monitoring - Track user behavior
  7. Threat History - Timeline of security events
  8. System Health - Infrastructure monitoring
  9. Agent Control - AI agent management
  10. NC4 Reporting - Incident reporting for compliance

🏗️ Technology Stack

Frontend

  • React 18 - UI framework
  • TypeScript - Type safety
  • React Router 7 - Navigation
  • Tailwind CSS 4 - Styling
  • Recharts - Data visualization
  • Lucide React - Icons
  • Motion - Animations

Backend

  • Supabase - Backend as a Service
  • Hono - Web server framework
  • Edge Functions - Serverless compute
  • KV Store - Data persistence

Build Tools

  • Vite - Build tool and dev server
  • pnpm - Package manager

📖 Documentation

🇰🇪 Kenya-Specific Features

  • NC4 Compliance - Direct integration with National Computer and Cybercrime Coordination Committee
  • Local Context - Case studies from Equity Bank, SHA fraud incidents
  • Currency - KES (Kenyan Shillings) throughout the application
  • Flag Colors - Black, Red, and Green theme elements
  • Contact - Kenyan cybercrime hotline: +254 716148341

🔐 Security Features

  • AI-powered behavioral analysis
  • Real-time threat detection
  • Automated file scanning
  • Risk scoring (0-100 scale)
  • User activity monitoring
  • Incident reporting
  • Audit logging

🎨 Design

  • Dark Theme - Professional cybersecurity aesthetic
  • Glass Morphism - Modern frosted glass effects
  • Cyber Colors - Cyan (#00ffff) accent color
  • Kenyan Flag - Black, Red (#BB0000), Green (#006600) stripes
  • Responsive - Mobile-first design approach

📊 Screenshots

Dashboard

Live threat alerts, statistics, and NC4 reporting

File Analysis

AI-powered file scanning with detailed threat analysis

User Monitoring

Real-time behavioral tracking and risk profiling

🤝 Contributing

This is a demonstration project built for the WRRIC Hackathon 2026.

📄 License

© 2026 WRRIC - Hackathon

🎓 Educational Purpose

This dashboard demonstrates:

  • Modern web architecture (React + Supabase + TypeScript)
  • AI/ML integration for cybersecurity
  • Real-time threat detection systems
  • Compliance reporting frameworks
  • Full-stack development best practices
  • Professional UI/UX design

🚀 Getting Started

Ready to run locally? Check out the LOCAL_SETUP.md guide!

# Quick start
pnpm install && pnpm dev

Built with ❤️ in Kenya 🇰🇪 for WRRIC Hackathon 2026