git_dash

This repo contains a Dash dashboard that displays stats for Github repos.

Production Setup

• Image an SD card with Screenly OSE (use Etcher)

• Create a file /boot/ssh on the SD Card (see #3 from the SSH page)

• Boot the Pi. Screenly will launch to a screen that shows the IP

• Connect using the IP: ssh pi@<IP> Password is raspberry

• Change the password: sudo passwd pi

• Update the package manager: sudo apt-get update

• Install pip3: sudo apt-get install python3-pip

• Install gunicorn: sudo pip3 install gunicorn

• Download and install Redis

  • make (to build the program)
  • sudo make install (to copy program files to the default locations)
  • sudo utils/install_server.sh (to cause the Redis server to run at boot)

• Clone this repo to the Pi (and go into the directory)

• Install the dependencies (as root): sudo pip3 install -r requirements.txt

• Install the packages (as root): sudo pip3 install . (use -e if you plan to edit the files after install)

• Create a file named .env that contains GITHUB_TOKEN=<TOKEN> (replace <TOKEN> with a GitHub Personal Access Token with repo access)

• Note the name of the directory: pwd

• Edit /etc/rc.local and add the following above exit 0: (Replace <repo dir> with the absolute path and note the & at the end of each line!)

  python3 <repo dir>/src/github_collect/collector.py &
  gunicorn --chdir  <repo dir>/src/github_dash -b 0.0.0.0:8050 app:server &
  

• Reboot: sudo reboot

• Point a web browser at http://<Pi IP>

• Add the dashboard as an asset: http://localhost:8050

  • After adding, edit it to make the end date something more than 1 week in the future.

• Turn on the dashboard asset (and remove the default assets)

• Under settings, disable "Show spash screen" so the IP is not shown at boot. Click "Save Settings" to save

• Reboot again