https://github.com/snivilised/balloons

🎈 charm bubbletea bubbles
https://github.com/snivilised/balloons

Last synced: about 1 year ago
JSON representation

🎈 charm bubbletea bubbles

• Host: GitHub
• URL: https://github.com/snivilised/balloons
• Owner: snivilised
• License: mit
• Created: 2024-12-10T11:34:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-03T07:45:15.000Z (over 1 year ago)
• Last Synced: 2025-02-08T03:41:22.564Z (over 1 year ago)
• Language: Shell
• Size: 51.8 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🎈balloons: ___charm bubbletea bubbles___

[![A B](https://img.shields.io/badge/branching-commonflow-informational?style=flat)](https://commonflow.org)

[![A B](https://img.shields.io/badge/merge-rebase-informational?style=flat)](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)

[![A B](https://img.shields.io/badge/branch%20history-linear-blue?style=flat)](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)

[![Go Reference](https://pkg.go.dev/badge/github.com/snivilised/balloons.svg)](https://pkg.go.dev/github.com/snivilised/balloons)

[![Go report](https://goreportcard.com/badge/github.com/snivilised/balloons)](https://goreportcard.com/report/github.com/snivilised/balloons)

[![Coverage Status](https://coveralls.io/repos/github/snivilised/balloons/badge.svg?branch=main)](https://coveralls.io/github/snivilised/balloons?branch=main&kill_cache=1)

[![Balloons Continuous Integration](https://github.com/snivilised/balloons/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/snivilised/balloons/actions/workflows/ci-workflow.yml)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![A B](https://img.shields.io/badge/commit-conventional-commits?style=flat)](https://www.conventionalcommits.org/)



  



## 🔰 Introduction

This project will contain functionality that uses entities from the [charm universe](https://charm.sh/) to define tui user interface components utilised by `snivilised` projects. In particular, it contains a `highway` control (custom charm bubble) that aims to provide a front end view of a worker pool, although there is nothing to say that this is it's only application.

### 🎯 Highway

The highway contains multiple lanes representing different threads of execution, underpinned by a worker pool. As activity occurs, the corresponding lane in the highway updates to reflect completion of a job. However it is important to note that the highway, does not need to represent a worker pool, it can represent anything that can be visually represented by the concept of a group of lanes. The motivation for this control came from the need to be able to demonstrate the concurrent behaviour of [🌀 agenor's](https://github.com/snivilised/agenor) navigator and the [🐜 pants](https://github.com/snivilised/pants) worker pool that supports it.

More details to follow...

## 📚 Usage

## 🎀 Features



  

  



+ unit testing with [Ginkgo](https://onsi.github.io/ginkgo/)/[Gomega](https://onsi.github.io/gomega/)

+ i18n with [go-i18n](https://github.com/nicksnyder/go-i18n)

+ linting configuration and pre-commit hooks, (see: [linting-golang](https://freshman.tech/linting-golang/)).