OrgGo
/
termdash
mirror of https://github.com/mum4k/termdash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
22 Commits 7 Branches 27 Tags 113 MiB
Go 99.9%
Go to file
Jakub Sobon 16de0d2b87
Fixing build and test errors. 		2018-04-02 00:47:08 +02:00
area Implementation of container and its tests. 2018-04-01 00:57:33 +02:00
canvas Implementing canvas functionality. 2018-03-29 03:28:36 +03:00
cell Implementing canvas functionality. 2018-03-29 03:28:36 +03:00
container Adding an "Error" event type. 2018-04-02 00:43:55 +02:00
doc Implementing cell, buffer, container options and fake terminal. 2018-03-28 21:34:20 +03:00
draw Fixing build and test errors. 2018-04-02 00:47:08 +02:00
keyboard Defining the APIs. 2018-03-27 19:01:35 +01:00
mouse Defining the APIs. 2018-03-27 19:01:35 +01:00
terminal Implementation of container and its tests. 2018-04-01 00:57:33 +02:00
terminalapi Fixing build and test errors. 2018-04-02 00:47:08 +02:00
widget Implementing cell, buffer, container options and fake terminal. 2018-03-28 21:34:20 +03:00
.gitignore Renaming display to terminal. 2018-03-26 16:31:20 +01:00
LICENSE Initial commit 2018-03-24 12:01:49 +00:00
README.md Defining the APIs. 2018-03-27 19:01:35 +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.
  3. The project is released under a licence I cannot use.

Design goals

This effort is focused on good software design and maintainability. By a good software 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.

Project status

  • High-Level Design.
  • Submit the APIs.
  • Implement the terminal layer.
  • Implement the container.
  • Implement the input event pre-processing.
  • Implement the infrastructure layer.
  • Implement unit test helpers.
  • Implement the first widget.
  • Documentation and tooling for widget development.
  • Launch and iterate.