OrgGo
/
termdash
mirror of https://github.com/mum4k/termdash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
65 Commits 7 Branches 27 Tags 113 MiB
Go 99.9%
Go to file
Jakub Sobon e2a4927612
Adding licences. 		2018-05-08 01:14:36 +01:00
align Adding licences. 2018-05-08 01:14:36 +01:00
area Adding licences and a script to automate the same. 2018-04-14 23:06:57 +01:00
canvas A function that draws a rectangle. 2018-05-06 19:28:52 +01:00
cell Adding licences and a script to automate the same. 2018-04-14 23:06:57 +01:00
container Exposing alignment directly instead wrapping in options. 2018-05-07 21:48:22 +01:00
doc Implementing the Gauge widget. 2018-05-08 01:12:36 +01:00
draw Adding licences. 2018-05-08 01:14:36 +01:00
eventqueue Don't pop from the queue after context expiry. 2018-04-23 00:46:36 +01:00
images Implementing the Gauge widget. 2018-05-08 01:12:36 +01:00
keyboard Adding licences and a script to automate the same. 2018-04-14 23:06:57 +01:00
mouse Adding licences and a script to automate the same. 2018-04-14 23:06:57 +01:00
scripts Licence for the autogen script. 2018-04-14 23:08:34 +01:00
terminal A function that draws a rectangle. 2018-05-06 19:28:52 +01:00
terminalapi Adding licences and a script to automate the same. 2018-04-14 23:06:57 +01:00
widgetapi A widget option to specify the maximum canvas size. 2018-05-07 12:42:19 +01:00
widgets Adding licences. 2018-05-08 01:14:36 +01:00
.gitignore
…
CONTRIBUTING.md Adding a CONTRIBUTING.md file. 2018-04-14 23:02:18 +01:00
LICENSE
…
README.md Adding licences. 2018-05-08 01:14:36 +01:00
termdash.go Improving error handling. 2018-05-07 21:30:38 +01:00
termdash_test.go Improving error handling. 2018-05-07 21:30:38 +01:00

README.md

termdash

This project implements a terminal based dashboard. The feature set is inspired by the gizak/termui project, which in turn was inspired by a javascript based yaronn/blessed-contrib. Why the rewrite you ask?

  1. The above mentioned gizak/termui is abandoned and isn't maintained anymore.
  2. 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.
  2. Only beautiful, simple APIs, no exposed concurrency, channels, internals, etc.
  3. Follow Effective Go.
  4. Provide an infrastructure that allows development of individual dashboard components in separation.
  5. The infrastructure must enforce consistency in how the dashboard components are implemented.
  6. 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.
  2. Simple container management to position the widgets and set their size.
  3. Mouse and keyboard input.
  4. Cross-platform terminal based output.
  5. Unit testing framework for simple and readable tests of dashboard elements.
  6. Tooling to streamline addition of new widgets.
  7. Apache-2.0 licence for the project.

High-Level design

See the design document.

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 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. Please familiarize yourself with these before contributing.

Contributing widgets

If you're developing a new widget, please see the widget development section.

Implemented Widgets

The Gauge

Run the gaugedemo.

gaugedemo