A dashboard that does not need a full web server stack. It runs completely locally over a LAN so that a person could impromptu pop up on a display for group work without worrying about infrastructure or internet security postures. This project uses a JSON file to read in the list of tasks, and updates it at an interval (a default of 5 minutes). There is also an option to display a QR code to save on typing the complete URI.
- Follow the instructions under the Usage heading to download/build the application.
- 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.
- 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.
- 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. - Logging can be found under log.txt, which contains INFO, DEBUG, and ERROR messages for the webserver.
- Download the relavent zipfile from the Releases Tab
- Unzip and run the executable as is.
- Install golang
- Clone the repo
- Build the project by running
go buildin the repository directory - 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!
This project is licensed under the GNU GPLv3 with the Common Clause v1 added.