Skip to content

btwshivam/watchdog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Watchdog 🐾

Watchdog 🐾 Logo

Modern Security Scanning Platform with AI-Powered Analysis

Secure. Scan. Analyze. Remediate.

Features β€’ Tech Stack β€’ Screenshots β€’ Architecture β€’ Installation β€’ Development β€’ Roadmap


Overview

Watchdog 🐾 is a powerful, modern GUI-based security scanner that provides comprehensive vulnerability detection, technology stack identification, and AI-powered security analysis for web applications. Built with a sleek, modern UI using Wails, React, and Tailwind CSS v4, it brings enterprise-level security scanning capabilities to the desktop.

Features

πŸ” Advanced Security Scanning

  • Comprehensive Vulnerability Detection: Identifies security vulnerabilities with CVSS scoring
  • Technology Stack Identification: Detects frameworks, languages, and libraries
  • SSL/TLS Analysis: Analyzes certificates and protocols with security grading
  • DNS Information Gathering: Collects DNS records and configuration data
  • Real-time Progress Tracking: Monitor scans with live progress updates

πŸ€– AI-Powered Analysis

  • Multi-Provider AI Integration:
    • OpenAI GPT support
    • Google Gemini support
    • Claude support (placeholder)
  • Automated Security Reports: Generate detailed analysis of vulnerabilities
  • Remediation Recommendations: AI-generated security improvement suggestions

πŸ“Š Modern Dashboard & UI

  • Clean, Modern Interface: Glassmorphism design with subtle gradients
  • Responsive Design: Works seamlessly across all screen sizes
  • Real-time Analytics: Security scoring and vulnerability metrics
  • Scan History Management: Browse, filter, and search past scans

πŸ“ Comprehensive Reporting

  • Multiple Export Formats: PDF and JSON export options
  • Customizable Reports: Configure report content and branding
  • Shareable Results: Easy export and sharing capabilities

Tech Stack

Backend

  • Go: Core application logic
  • Wails v2: Native desktop application framework
  • LevelDB: Local storage for scan results and configuration
  • AI Integration:
    • Google Generative AI SDK
    • OpenAI API
    • Claude API (placeholder)

Frontend

  • React: UI component framework
  • Tailwind CSS v4: Modern styling with the latest features
  • React Router v6: Navigation and routing
  • Framer Motion: Smooth animations and transitions
  • Recharts: Data visualization
  • Lucide Icons: Clean, consistent iconography

Screenshots

[Screenshots would be placed here]

Architecture

Watchdog 🐾 follows a clean architecture pattern with clear separation of concerns:

Backend Services

backend/
β”œβ”€β”€ scanner/service.go   # Core scanning functionality
β”œβ”€β”€ ai/service.go        # AI integration with multiple providers
β”œβ”€β”€ config/manager.go    # Configuration and API key management
└── storage/manager.go   # Data persistence and report generation

Frontend Structure

frontend/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ pages/           # Main application screens
β”‚   β”œβ”€β”€ components/      # Reusable UI components
β”‚   β”œβ”€β”€ styles/          # Tailwind v4 styling
β”‚   └── types/           # TypeScript definitions
└── wailsjs/            # Generated Wails bindings

Key Components

  1. Scanner Service: Handles all security scanning operations
  2. AI Service: Manages AI provider integrations and report generation
  3. Storage Manager: Handles data persistence and exports
  4. Configuration Manager: Manages application settings and API keys

Installation

Prerequisites

  • Go 1.19+
  • Node.js 16+
  • Wails v2.10.1+

Build from Source

# Clone repository
git clone https://github.com/btwshivam/watchdog.git
cd watchdog

# Install dependencies
go mod download
cd frontend && npm install
cd ..

# Build application
wails build

Pre-built binaries for Windows, macOS, and Linux are available in the releases section.

Development

Setup Development Environment

# Install Wails if not already installed
go install github.com/wailsapp/wails/v2/cmd/wails@latest

# Start development server with hot reload
wails dev

Directory Structure

watchdog/
β”œβ”€β”€ app.go                # Main Wails application context
β”œβ”€β”€ main.go               # Application entry point
β”œβ”€β”€ backend/              # Backend Go services
β”œβ”€β”€ frontend/             # React frontend
β”œβ”€β”€ build/                # Build configuration and resources
└── cmd/                  # CLI tools and testing utilities

Testing

The project includes comprehensive test suites:

# Run backend integration tests
cd cmd/test
go run main.go

# Run API integration tests
cd cmd/test-api
go run main.go

Roadmap

Near-term Improvements

  • Real-time scan progress with WebSocket updates
  • Advanced dashboard analytics and metrics
  • Scan scheduling and automation
  • Custom vulnerability rules and filters

Future Enhancements

  • Plugin system for custom security scanners
  • Cloud integration for result storage
  • Team collaboration features
  • Mobile companion app for monitoring

License

MIT

Author

Shivam

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published