OctoWatch - GitHub Enterprise Monitor

The Repository

This repository (OctoWatch) is where we (Xebia) develop the OctoWatch - GitHub Enterprise Monitor product together with the community.
We use this repo not only to build code and track issues, but also to share our roadmap, development setup, and future plans.
The source code is available under the standard Microsoft Public License.

OctoWatch

OctoWatch is a monitoring and governance tool for GitHub Enterprise accounts.
It helps organizations detect security issues, ensure compliance, and maintain best practices across their GitHub repositories and teams.

Key features include:

• GitHub App Integration – Secure connection to GitHub Enterprise
• Organization Scanning – Analyze all organizations and repositories
• Security Issue Detection:
  • 🛡️ Repositories without branch protection
  • 👑 Teams with admin access
  • 😴 Users inactive for 90+ days

OctoWatch is currently in MVP stage, and is evolving quickly.

---

📷 Screenshots

Dashboard

Organization Overview

Repository Details

User Details

Team Details

Naming Policy

Stale Repositories

Visibility Audit

Branch Protections

License Validator

---

🚀 Quick Start

Prerequisites

• Node.js 18+
• .NET 9 SDK
• Git

Development Setup

1. Clone the repository

   git clone <repository-url>
   cd OctoWatch001

2. Start the backend API

   cd backend/OctoWatch.Api
   dotnet run

   The API will start on http://localhost:5000

3. Start the frontend (in a new terminal)

   npm install
   npm run dev

   The app will start on http://localhost:5173

🔧 Development

Frontend commands

• npm run dev — Start development server
• npm run build — Build for production
• npm run preview — Preview production build
• npm run lint — Run ESLint

Backend commands

• dotnet run — Start the API server
• dotnet build — Build the project
• dotnet test — Run tests (when added)

---

🌐 API Endpoints

• GET /api/github/enterprise-scan — Get enterprise scan results
• GET /api/health — Health check endpoint

---

🛠️ Technology Stack

Frontend

• React 18
• TypeScript
• Vite
• CSS3 (Custom styling)

Backend

• ASP.NET Core 9
• Minimal APIs
• OpenAPI/Swagger

---

🎯 Roadmap

Phase 1 (Current MVP)

• Basic UI with scan summary
• Security issues detection
• Organization overview
• Mock data integration

Phase 2 (Planned)

• Real GitHub API integration
• GitHub App authentication
• Advanced filtering and search
• Export reports (PDF/CSV)

Phase 3 (Future)

• Automated remediation suggestions
• Compliance reporting
• Real-time notifications
• Custom rules engine

---

Contributing

There are many ways to participate in OctoWatch:

• Submit bugs and feature requests
• Review source code changes
• Improve documentation

We don’t have a formal contribution guide yet, but one will be published soon in the wiki.

---

Feedback

We’d love your feedback! You can:

• Start or join a discussion on GitHub Discussions
• Request a new feature
• Upvote popular feature requests
• File an issue

---

Related Projects

OctoWatch is built to complement GitHub Enterprise. Some related resources:

• GitHub API documentation
• GitHub Enterprise security best practices
• Open source governance tools

---

Development Container

This repository includes a Dev Container setup for VS Code / GitHub Codespaces.

• For Dev Containers, use Dev Containers: Clone Repository in Container Volume… in VS Code.
• For Codespaces, install the GitHub Codespaces extension and run Codespaces: Create New Codespace.

Your environment should have at least 4 cores and 6 GB RAM (8 GB recommended) for full builds.

---

Top Contributors

Made with [contrib.rocks](https://contrib.rocks).

---

License

Copyright (c) 2025 Xebia.

Licensed under the Microsoft Public License license.