README.md

DevDash is a highly configurable terminal dashboard for developers, who want to choose and display the most up-to-date metrics they need, at one place.

Why using DevDash?

• Choose the metrics you specifically need.
• All the important data in your cosy terminal.
• Pull data from Github, Google Analytics or Google Search Console. More services to come!
• Unlimited amount of different dashboards with different configurations.
• Widgets' data refreshed automatically.
• A huge amount of flexibility compared to other terminal dashboards:
  • Choose the widgets you want.
  • Place your widgets where you want.
  • Choose the data you want to display, the colors you want to use, and a lot of other things for each widget.

Menu

• Installation
• Documentation
• Acknowledgement
• Contribute
• Licence
• Making of
• Showcase

Installation

You can simply grab the latest released binary file and download the version you need, depending on your OS.

Linux script

Here's a simple way to download DevDash and move it in /usr/local/bin, in order to be able to use DevDash everywhere easily.

curl -LO https://raw.githubusercontent.com/Phantas0s/devdash/master/install/linux.sh && \
sh ./linux.sh && \
rm linux.sh

Manual installation

You need Golang installed to compile DevDash.

You simply need to run go get -u github.com/Phantas0s/devdash/cmd/devdash in your terminal.

Documentation

The documentation is here.

In there you will find:

• Installation / getting started
• Simple examples and real use cases
• Complete reference of dashboard configurations

Acknowledgement

Thanks to MariaLetta for the awesome and beautiful Gopher pack she made! I used it for my logo on top.

DevDash was inspired from other open source projects:

• wtf
• tdash

Contribute

First of all, thanks a lot if you want to contribute to DevDash!

I think the "talk, then code" practice is pretty good to avoid misunderstandings and hours of work for nothing.

Therefore:

"Every new feature or bug fix should be discussed with the maintainer(s) of the project before work commences. It’s fine to experiment privately, but do not send a change without discussing it first."

Making Of

For anybody interested how I managed to develop DevDash on side of a full time job, and how I organized my time and kept my motivation, I wrote an article about that on my blog.

Licence

Apache Licence 2.0

Showcase