mirror of https://github.com/mum4k/termdash.git
89 lines
3.5 KiB
Markdown
89 lines
3.5 KiB
Markdown
[](https://godoc.org/github.com/mum4k/termdash)
|
|
[](https://travis-ci.org/mum4k/termdash)
|
|
[](https://coveralls.io/github/mum4k/termdash?branch=master)
|
|
[](https://goreportcard.com/report/github.com/mum4k/termdash)
|
|
[](https://github.com/mum4k/termdash/blob/master/LICENSE)
|
|
|
|
# termdash
|
|
|
|
This project implements a terminal based dashboard. The feature set is inspired
|
|
by the [gizak/termui](http://github.com/gizak/termui) project, which in turn
|
|
was inspired by a javascript based
|
|
[yaronn/blessed-contrib](http://github.com/yaronn/blessed-contrib). Why the
|
|
rewrite you ask?
|
|
|
|
1. The above mentioned [gizak/termui](http://github.com/gizak/termui) is
|
|
abandoned and isn't maintained anymore.
|
|
1. The project doesn't follow the design goals outlined below.
|
|
|
|
# Design goals
|
|
|
|
This effort is focused on good software design and maintainability. By good
|
|
design I mean:
|
|
|
|
1. Write readable, well documented code.
|
|
1. Only beautiful, simple APIs, no exposed concurrency, channels, internals, etc.
|
|
1. Follow [Effective Go](http://golang.org/doc/effective_go.html).
|
|
1. Provide an infrastructure that allows development of individual dashboard
|
|
components in separation.
|
|
1. The infrastructure must enforce consistency in how the dashboard components
|
|
are implemented.
|
|
1. Focus on maintainability, the infrastructure and dashboard components must
|
|
have good test coverage, the repository must have CI/CD enabled.
|
|
|
|
On top of that - let's have fun, learn something and become better developers
|
|
together.
|
|
|
|
# Requirements
|
|
|
|
1. Native support of the UTF-8 encoding.
|
|
1. Simple container management to position the widgets and set their size.
|
|
1. Mouse and keyboard input.
|
|
1. Cross-platform terminal based output.
|
|
1. Unit testing framework for simple and readable tests of dashboard elements.
|
|
1. Tooling to streamline addition of new widgets.
|
|
1. Apache-2.0 licence for the project.
|
|
|
|
# High-Level design
|
|
|
|
See the [design document](doc/hld.md).
|
|
|
|
# Contributing
|
|
|
|
If you are willing to contribute, improve the infrastructure or develop a
|
|
widget, first of all Thank You! Your help is appreciated.
|
|
|
|
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines related
|
|
to the Google's CLA, and code review requirements.
|
|
|
|
As stated above the primary goal of this project is to develop readable, well
|
|
designed code, the functionality and efficiency come second. This is achieved
|
|
through detailed code reviews, design discussions and following of the [design
|
|
guidelines](doc/design_guidelines.md). Please familiarize yourself with these
|
|
before contributing.
|
|
|
|
## Contributing widgets
|
|
|
|
If you're developing a new widget, please see the [widget
|
|
development](doc/widget_development.md) section.
|
|
|
|
## Implemented Widgets
|
|
|
|
### The Gauge
|
|
|
|
Displays the progress of an operation. Run the
|
|
[gaugedemo](widgets/gauge/demo/gaugedemo.go).
|
|
|
|
[<img src="./images/gaugedemo.gif" alt="gaugedemo" type="image/gif">](widgets/gauge/demo/gaugedemo.go)
|
|
|
|
### The Text
|
|
|
|
Displays text content, supports trimming and scrolling of content. Run the
|
|
[textdemo](widgets/text/demo/textdemo.go).
|
|
|
|
[<img src="./images/textdemo.gif" alt="gaugedemo" type="image/gif">](widgets/gauge/demo/gaugedemo.go)
|
|
|
|
## Disclaimer
|
|
|
|
This is not an official Google product.
|