AegisNet

---

🌐 Live Site

Visit the AegisNet Website

The live site features:

• Project Information - Overview, quick start, and tech stack
• Statistics - Repository metrics and activity charts
• Discussions - Browse community discussions
• Development Board - Track project progress
• Documentation - Comprehensive guides and docs
• Visualizer - Interactive Mermaid diagrams
• Dark/Neon Themes - 7 user-selectable themes

Overview

AegisNet is an advanced defense product solution that integrates several cutting-edge technologies. Our goal is to provide a comprehensive system that combines situational awareness, advanced detection surveillance, autonomous drone software, and more into a unified platform.

🚀 Quick Start

Local Development

# Clone the repository
git clone https://github.com/cywf/AegisNet.git
cd AegisNet

# Run setup script
./scripts/setup-local.sh

# Or use Make
make dev

Cloud Deployment

# Deploy infrastructure
make deploy

# Or manually
./scripts/deploy-cloud.sh

See the Deployment Guide for detailed instructions.

📋 Documentation

Access documentation through:

• Live Documentation Site - Interactive documentation browser
• Deployment Guide - Complete deployment instructions
• Architecture - System architecture and design
• Terraform Guide - Infrastructure as Code
• Kubernetes Guide - Container orchestration
• Roadmap - Project timeline and milestones

Adding Documentation

To add new documentation:

1. Create a Markdown file in the /docs/ directory
2. The file will automatically appear on the documentation page
3. CI will process and display it with proper formatting and navigation

🗺️ Project Diagrams

Adding Mermaid Diagrams

To add new Mermaid diagrams:

1. Create a .mmd file in the /mermaid/ directory
2. The diagram will automatically appear on the visualizer page
3. CI will copy and index it for interactive viewing

Example diagram structure:

graph TD
    A[Start] --> B[Process]
    B --> C[End]

Loading

Existing diagrams:

• architecture.mmd - System architecture
• flowchart.mmd - Process flows
• er.mmd - Entity relationships
• ci-sequence.mmd - CI/CD sequence
• bpmnish.mmd - Business process

🗺️ Live Codebase Mindmap

Auto-generated on each push: repo-map.html (via GitHub Pages and CI artifact).

Access at: https://cywf.github.io/AegisNet/repo-map.html

The interactive mindmap provides a visual overview of the repository structure, including:

• Directory tree visualization
• Language distribution statistics
• Expandable/collapsible nodes for easy navigation

🛠️ Technologies

AegisNet incorporates the following technologies:

• FreeTAKServer: A server that provides situational awareness, compatible with TAK clients.
• Heimdall: An advanced detection surveillance system that uses AI and ML for facial recognition and behavior analysis.
• Sentinel Project: A security system designed to protect critical infrastructure from cyber threats.
• Prometheus: An open-source autonomous drone software platform.
• RadareEye: A tool that scans nearby devices and executes a command on its own system when the target device comes into range.
• Traffic: A toolbox for processing and analyzing air traffic data.

🏗️ Infrastructure

AegisNet supports multiple deployment models:

Local Development

• Docker & Docker Compose: Containerized local environment
• Quick setup: One-command deployment

Cloud Deployment

• AWS: ECS, EKS with Terraform modules
• Azure: AKS with managed services
• Google Cloud: GKE with cloud-native integration
• DigitalOcean: Kubernetes clusters
• Multi-cloud: Flexible provider selection

Autonomous/Edge Deployment

• K3s: Lightweight Kubernetes for edge
• Offline capable: Air-gapped deployment support
• Resource efficient: Optimized for constrained environments

🔧 Features

• ✅ Docker Support: Fully containerized architecture
• ✅ Kubernetes Ready: Production-grade orchestration
• ✅ Infrastructure as Code: Terraform for all major cloud providers
• ✅ CI/CD Pipelines: GitHub Actions for automated testing and deployment
• ✅ Security Scanning: Automated vulnerability detection
• ✅ Auto-scaling: Horizontal pod autoscaling
• ✅ Monitoring: Prometheus & Grafana integration
• ✅ Multi-environment: Dev, staging, and production configs

📦 Project Structure

AegisNet/
├── .github/workflows/    # CI/CD pipelines
│   └── pages.yml        # GitHub Pages deployment
├── docs/                 # Documentation
├── infra/               # Infrastructure as Code
│   ├── kubernetes/      # Kubernetes manifests
│   └── terraform/       # Terraform configurations
├── mermaid/             # Mermaid diagram files (.mmd)
├── scripts/             # Deployment and utility scripts
├── site/                # Website source (Astro + React)
│   ├── public/          # Static assets and data snapshots
│   ├── scripts/         # Data fetching scripts
│   └── src/             # Site source code
├── Dockerfile           # Container definition
├── docker-compose.yml   # Local development setup
├── Makefile            # Common operations
└── README.md           # This file

🔄 CI/CD Data Snapshots

The website automatically fetches and displays live data from GitHub through CI/CD pipelines:

Data Sources

1. Repository Statistics (site/public/data/stats.json)

   • Stars, forks, watchers count
   • Programming language breakdown
   • 12-week commit activity histogram
   • Updated on every deployment

2. Discussions (site/public/data/discussions.json)

   • Latest 25 community discussions
   • Includes title, author, category, and creation date
   • Links directly to GitHub discussions

3. Project Board (site/public/data/projects.json)

   • GitHub Projects v2 items with status
   • Fallback to issues grouped by status labels
   • Kanban board visualization

4. Packages (site/public/data/packages.json)

   • GitHub Packages metadata (optional)
   • Container registry information

How It Works

The .github/workflows/pages.yml workflow:

1. Runs data fetching scripts using GITHUB_TOKEN
2. Generates JSON snapshots in site/public/data/
3. Copies Mermaid diagrams to site/public/diagrams/
4. Builds the Astro site with fresh data
5. Deploys to GitHub Pages

All data fetching happens server-side during build - no tokens are exposed client-side.

🎯 Common Commands

# Website development (in site/ directory)
npm run dev          # Start dev server at localhost:4321
npm run build        # Build for production
npm run preview      # Preview production build
npm run fetch-data   # Fetch fresh data from GitHub API
npm run copy-diagrams # Copy Mermaid diagrams to public

# Local development
make dev          # Start local development environment
make logs         # View logs from all services
make stop         # Stop all services
make clean        # Clean up containers and images

# Infrastructure
make tf-plan      # Preview Terraform changes
make tf-apply     # Apply Terraform changes

# Kubernetes
make k8s-deploy   # Deploy to Kubernetes
make k8s-status   # Check deployment status
make k8s-logs     # View pod logs

# Validation
make validate     # Validate all configurations
make security-scan # Run security scans

👥 Team Structure

Our team is composed of:

• Developers (DV): Maintain the code base.
• Engineers (EG): Handle the architecture, strategy, and logic.
• Tactical Units (TU): Simulated tactical units utilizing what we make and testing it out in the field.
• Command (CO): Comprises of HR, admin personnel, as well as Command and handle operations.
• Contributors (CT): Our future contributors.
• Quality Assurance (QA): Responsible for testing and quality assurance.
• Incident Response (IR): Handles incident response.

📅 Project Timeline

• 1 Month: Organizational structure and project management tools in place.
• 3 Months: Development environment finalized to match our desired production environment.
• 6 Months: Project deployed in the field / production environments.

See roadmap.md for detailed milestones.

🔒 Security

• Secrets Management: Environment-based configuration
• Container Scanning: Automated vulnerability detection
• Secret Detection: Pre-commit hooks for sensitive data
• Security Scanning: Trivy and TruffleHog integration
• Network Security: Multi-layer defense approach

🤝 Contributing

We welcome contributions! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and validation: make validate
5. Submit a pull request

📝 License

All rights reserved until license terms are defined.

🆘 Support

• Issues: GitHub Issues
• Documentation: Check the docs/ directory
• Discussions: GitHub Discussions

🙏 Acknowledgments

Built with modern DevOps practices and cloud-native technologies for a secure, scalable, and autonomous defense platform.