Skip to content

Visualize your Kubernetes clusters through a GUI and query cluster data through custom command lines in your terminal.

License

Notifications You must be signed in to change notification settings

oslabs-beta/Kuberneat

Repository files navigation

⚡ Kuberneat ⚡

osLabs

version

GitHub language count GitHub top language

GitHub forks GitHub Repo stars GitHub watchers


Supported OS

mac

linux

Windows


Features

screen-gif

screen-gif

screen-gif

screen-gif

img

img

(back to top)

Getting Started With Kuberneat

Running Kuberneat

  1. Fork and clone the dev branch onto your local branch.

    https://github.com/oslabs-beta/Kuberneat.git
  2. Install all the dependencies

       npm install 
  3. Create process.env file at the root directory

    root
       ├─ process.env
       ├─ electron
       └─ src
  4. Connect to NoSQL database in .env

    mongoURI = "Your NoSQL URI string"
  5. Ensure your cluster is running and then you can start the desktop application with:

    npm run electron


(back to top)

Made with


For Frontend Development

Webpack MUI React React Router React Hook Form


For Backend Development

NodeJS Express.js MongoDB


For Monitoring and Data Visualizations

Kubernetes Docker Grafana Prometheus



(back to top)

Contributions

For more information regarding how to contribute, please refer to the CONTRIBUTING.md guidelines from this repo.

  1. Fork and clone the dev branch onto your local branch.

    https://github.com/oslabs-beta/Kuberneat.git
  2. Create a new a feature branch

    [your-name]/AWESOME-FEATURES
  3. Install all the dependencies

       npm install 
  4. Create process.env file at the root directory

    root
       ├─ process.env
       ├─ electron
       └─ src
  5. Connect to NoSQL database in .env

    mongoURI = "Your NoSQL URI string"
  6. Please ensure you are following eslint conventions.

  7. Please ensure to create tests for your feature and that it passes your test suite.

  8. Please be detailed in your pull request.

    img



(back to top)

Founders


(back to top)