Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.07 KB

README.md

File metadata and controls

44 lines (30 loc) · 2.07 KB
Raw

quick-dashboard

What is this?

A dashboard that doesnt need (or appear to need) a full web server stack. Something local, LAN, or BT that a person could imprompty pop up on a display for group work without standing up infra or internet security postures. Markdown or similar input, maybe a timer, check lists. Picture cleaning out a room with friends and having the action plan on a monitor

Right down to who is eyes on a situation and who is doing background work; impromptu signage etc.

How do you use it?

  1. Follow the instructions under the Usage heading to download/build the application.
  2. Upon running the executable, the program will prompt you for a filepath on where to fetch the data from (examples of which can be found under testData in this repo.
  3. It will find the local IP of the device on the network and ask if that is okay to use. Typing 'N' will prompt for an IP address and a port number to use.
  4. A webserver will run using the address provided and generate a QR code under static/qr.png. which can be used to quickly access the webserver from other devices.
  5. Logging can be found under log.txt, which contains INFO, DEBUG, and ERROR messages for the webserver.

Screenshots

On a Computer

image image

On a Phone

image image

Usage

Pre-built

  1. Download the relavent zipfile from the Releases Tab
  2. Unzip and run the executable as is.

Build

  1. Install golang
  2. Clone the repo
  3. Build the project by running go build in the repository directory
  4. Run the executable.

It is important that you keep the static folder and main.go where they are, as they are necessary for each other.

Feedback is always appriciated!

License

This project is licensed under the GNU GPLv3 with the Common Clause v1 added.