/k8s-navigator

K8S Navigator is an Electron-powered desktop application that simplifies Kubernetes cluster management and monitoring.

Primary LanguageTypeScript

K8S Navigator

License

K8S Navigator is an Electron desktop application built with TypeScript and React for managing and monitoring Kubernetes clusters. This tool is designed with a strong emphasis on accessibility, ensuring that it can be used by everyone, regardless of their abilities.

Key Features

  • Intuitive Interface: User-friendly dashboard for managing Kubernetes resources.
  • Accessibility: Built with accessibility in mind, supporting:
    • Keyboard Navigation: All features can be accessed and used without a mouse.
    • Screen Reader Compatibility: Clear semantic HTML and ARIA attributes for screen reader users.
    • High Contrast Mode: Optimized color contrast for users with visual impairments.
    • Focus Management: Clear focus indicators for keyboard navigation.

Demo

Watch the video

Installation

You can install K8S Navigator:

brew tap islam3zzat/k8s-navigator

brew install --cask k8s-navigator

Development

  1. Prerequisites:

    • Node.js and npm (or yarn) installed on your system.
    • A Kubernetes cluster to connect to (minikube, Docker Desktop, or a cloud provider's cluster).
  2. Clone the Repository:

    git clone https://github.com/islam3zzat/k8s-navigator.git
  3. Install Dependencies:

    npm install

    or

    yarn install

    or

    pnpm install
  4. Run the App:

    or

    yarn start

    or

    pnpm start

Accessibility Guidelines

This project follows the Web Content Accessibility Guidelines (WCAG) 2.1 to ensure that it is accessible to people with disabilities. We strive to meet at least AA level compliance.

Contributing

We welcome contributions to improve the project, either by raising issues, fixing them, suggesting features, or implementing them.

License

This project is licensed under the MIT License