oslabs-beta / kubby-buddy

Kubby Buddy, your container management buddy. Making Docker easier.

Home Page:https://kubbybuddy.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Table of Contents

Visit our docker extenstion repository here

ABOUT

Kubby Buddy is your container management buddy, giving you an easy to use GUI for all your Docker needs. All you need to do is launch our application, and your local images will load into our app, from there you can easily view, launch, stop and even delete your containers and images straight from our app. We also include metrics and even averages of your CPU and memory usgage utilizing a containerized database running on your local machine.

Demo

Here we can see creating a container from an image.

Here we can see our running containers, starting and stopping those containers as well as the logs for those containers.

Here we create a new volume, then delete it.

SETUP

Follow these steps for easy setup.

  1. Fork and clone this repository.
git clone https://github.com/<your-github-username>/kubby-buddy.git
  1. Navigate to the directory of the cloned repository.
cd kubby-buddy
  1. Install the npm packages.
npm install
  1. Start kubby buddy in your terminal.
npm start
  1. In your browser open 'http://localhost:8080/'.

And you're done, enjoy the simplicity of using your new container management buddy.

File Structure

.
├── LICENSE
├── README.md
├── __mocks__
│   ├── dockerode.ts
│   ├── fileMock.ts
│   ├── node-fetch.ts
│   └── urlMock.ts
├── __tests__
│   ├── controllers
│   └── routes
├── babel.config.js
├── cypress
│   ├── e2e
│   ├── fixtures
│   ├── integration
│   └── support
├── cypress.config.ts
├── docker-compose.yml
├── jest.config.ts
├── package-lock.json
├── package.json
├── server
│   ├── controllers
│   ├── db.ts
│   ├── models
│   ├── routes
│   ├── server.ts
│   └── util.ts
├── src
│   ├── App.scss
│   ├── App.tsx
│   ├── UserContext.tsx
│   ├── assets
│   ├── components
│   ├── global.d.ts
│   ├── index.html
│   ├── index.tsx
│   └── types.ts
├── tsconfig.json
├── types.ts
└── webpack.config.cjs

Contibuting

Contributing is what makes the open source community great. If you want to contribute to this project, you can follow these guidelines.

  • Fork and clone the repository.
  • Branch off the dev branch, with a branch name starting in feat, fix, bug, docs, test, wip or merge, then adding a new folder named whatever it is you are adding. (ex. feat/database)
  • When you commit, be sure to follow conventional commit standards.
  • Once your new feture is built out, you can submit a pull request to dev.

Progress

Feature Status
Image page
Container page
Volume page
Fix containerized database
Impliment Grafana
Bring extention to feature parody
Add alerts for when buttons fail to load
Fix container not loading when started outside the app
Add more diverse and costomizable commands
  • = Finished feature
  • = Work in progress feature
  • = Not yet started feature

Meet the Team!


Chang Moon

Josh Goo

Steve Lemlek

Trey Walker

William Reilly

License

This project is licensed under the terms of the MIT LICENSE.

About

Kubby Buddy, your container management buddy. Making Docker easier.

https://kubbybuddy.com/

License:MIT License


Languages

Language:TypeScript 84.7%Language:SCSS 10.8%Language:Shell 2.8%Language:JavaScript 1.1%Language:HTML 0.4%Language:Dockerfile 0.1%