https://github.com/oslabs-beta/kubby-buddy

Kubby Buddy, your container management buddy. Making Docker easier.
https://github.com/oslabs-beta/kubby-buddy

containers docker

Last synced: about 1 year ago
JSON representation

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

Host: GitHub
URL: https://github.com/oslabs-beta/kubby-buddy
Owner: oslabs-beta
License: mit
Created: 2023-06-09T16:15:54.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-01-19T20:06:42.000Z (over 2 years ago)
Last Synced: 2025-04-08T10:53:18.857Z (about 1 year ago)
Topics: containers, docker
Language: TypeScript
Homepage: https://kubbybuddy.com/
Size: 30.8 MB
Stars: 78
Watchers: 3
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Table of Contents

- [About](#about)
- [Demo](#demo)
- [Setup](#setup)
- [File Structure](#file-structure)
- [Contributing](#contibuting)
- [Progress](#progress)
- [Meet the Team](#meet-the-team)
- [License](#license)

### Visit our docker extenstion repository [here](https://github.com/oslabs-beta/kubby-buddy-extension)

## 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.

```bash
git clone https://github.com//kubby-buddy.git
```

2. Navigate to the directory of the cloned repository.

```bash
cd kubby-buddy
```

3. Install the npm packages.

```bash
npm install
```

4. Start kubby buddy in your terminal.

```bash
npm start
```

5. 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](https://www.conventionalcommits.org/en/v1.0.0/) 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 | |