faultmaven/faultmaven-dashboard repository overview

⁠FaultMaven Dashboard

The Command Center for Your Knowledge Engine

⁠About FaultMaven

FaultMaven is an AI-powered troubleshooting copilot that correlates your live telemetry with your runbooks, docs, and past fixes. It delivers answers grounded in your actual system—not generic guesses.

Learn More:

• Product Overview⁠ — See what FaultMaven can do
• Use Cases⁠ — Real-world troubleshooting scenarios
• Main Repository⁠ — Architecture and documentation

⁠🧠 Purpose

While the Copilot⁠ is for reacting to incidents, the Dashboard is for proactive management:

• Knowledge Base: Upload runbooks, edit indexed documents, and manage vectors
• Case History: View, search, and export past troubleshooting sessions
• Configuration: Manage LLM providers (OpenAI/Ollama) and API keys

⁠Dashboard vs Copilot

Both connect to the same FaultMaven backend.

⁠🚀 Quick Start

⁠Using the Full Stack (Recommended)

The dashboard is included automatically in the main deployment:

git clone https://github.com/FaultMaven/faultmaven-deploy.git && cd faultmaven-deploy
./faultmaven start

Access the dashboard at http://localhost:3000.

⁠Local Development

To run only this dashboard locally for development:

# 1. Clone
git clone https://github.com/FaultMaven/faultmaven-dashboard.git
cd faultmaven-dashboard

# 2. Install & Run
npm install
npm run dev

Access at http://localhost:5173.

⁠Docker Standalone

docker run -p 3000:80 \
  -e API_URL=http://localhost:8090 \
  faultmaven/faultmaven-dashboard:latest

Or use the full stack deployment⁠.

⁠🛠️ Development

⁠Setup

# Clone and install
git clone https://github.com/FaultMaven/faultmaven-dashboard.git
cd faultmaven-dashboard
npm install

# Run dev server (requires backend at localhost:8090)
npm run dev

# Run tests
npm run test

# Build for production
npm run build

# Preview production build
npm run preview

⁠Project Structure

src/
├── components/     # Shared UI (Header, UploadModal, ConfirmDialog, etc.)
├── context/        # AuthContext (global auth state)
├── hooks/          # Custom hooks (useKBList for KB paging/search/delete)
├── lib/            # API client, config, storage adapter
├── pages/          # Route pages (Login, KB, Admin KB)
└── utils/          # Helpers (debounce)

⁠Tech Stack

• Framework: React 19 + Vite (SPA)
• Routing: React Router 7
• Styling: Tailwind CSS
• State: React Context + custom hooks (no external state lib)
• Testing: Vitest + Testing Library
• Deployment: Static files (Nginx)

⁠🤝 Contributing

We welcome contributions to the FaultMaven Dashboard! Whether it's improving the knowledge base UI, adding new visualizations, or enhancing the user experience, your help makes FaultMaven better for everyone.

Note: This repository contains only the web dashboard UI. For backend features (AI agent, knowledge base, microservices), see the main FaultMaven repository⁠.

Getting Started:

• Check out good-first-issue⁠ tags for beginner-friendly tasks
• See our Contributing Guide⁠ for detailed guidelines
• Join GitHub Discussions⁠ to share ideas

⁠📄 License

This project is licensed under the Apache 2.0 License - see the LICENSE⁠ file for details.

⁠🔗 Related Projects

The FaultMaven ecosystem includes:

• faultmaven⁠ - Main repository with microservices backend
• faultmaven-copilot⁠ - Browser extension for in-flow troubleshooting
• faultmaven-deploy⁠ - Deployment configurations and tooling
• faultmaven-website⁠ - Official website

⁠Support

• Discussions: GitHub Discussions⁠
• Issues: GitHub Issues⁠

FaultMaven — Your AI copilot for troubleshooting.