verpi

README

verpi

🚥 See the status of your vercel deployments on the pimoroni blinkt!

• verpi
  • 🎥 Demo
  • 🚥 Setup your own version
    • 💵 Getting the parts
    • 🚥 Install the pimoroni blinkt
    • 🖼️ Flash an image
    • 🥾 Headless boot
    • 🚀 Installing the needed deps
    • 🔑 Creating a token
    • 🚀 Installing verpi
    • 👋 Uninstalling verpi
  • ⚙️ Configuring verpi
  • 🙌 Contributing
  • 👥 Contributors

🎥 Demo

https://user-images.githubusercontent.com/43759105/132117267-ec147769-a7af-4f61-bdc8-269a1fd8a466.mp4

Note: Normally all 8 LEDs would be lit up but I only have 6 projects on vercel so only 6 are lit up.

🚥 Setup your own version

Setting up verpi for yourself is very simple! Just follow the instructions below. If you have any problems please make an issue on this repo.

💵 Getting the parts

• Case, Card, Heat sink, and other tools - $8.99
• Raspberry Pi Zero WH (Zero W with Headers) - $39.95
• Power supply - $9.95
• Pimoroni blinkt - ~$8.32

🚥 Install the pimoroni blinkt

To install the pimoroni blinkt simply set it on the GPIO headers. The correct way round is where it has curves on the top that match the corners of your Raspberry Pi.

🖼️ Flash an image

To flash an operating system to the micro sd card please use the Raspberry Pi Imager program. You only need Raspberry Pi OS Lite for verpi to operate (with some dependencies installed later).

🥾 Headless boot

So you can ssh to the pi on boot please follow this tutorial for setting up the raspberry pi headless. It should only take a few seconds to do as you only need to make two small files.

Headless Raspberry Pi Tutorial.

🚀 Installing the needed deps

Before actually installing verpi you need a few deps installed. Please run the following terminal command on your raspberry pi:

sudo apt -yq update && sudo apt -yq upgrade && sudo apt install -yq wiringpi git wget

🔑 Creating a token

1. Create a token on vercel's token page with a name of verpi.
2. Copy the token to your clipboard.
3. On the raspberry pi add a file to ~/.config/verpi/ called conf.toml.
4. Add the following to that file, replacing <TOKEN> with your token.

token = "<TOKEN>"

🚀 Installing verpi

To install verpi just run the following command on your raspberry pi:

wget -q -O - https://raw.githubusercontent.com/gleich/verpi/master/setup.py | sudo python3 - install

This script will install a temporary version of golang to produce a binary and install a systemd service. It will not mess with whatever version of go you might already have installed on the pi.

👋 Uninstalling verpi

To uninstall verpi just run the following command on your raspberry pi:

wget -q -O - https://raw.githubusercontent.com/gleich/verpi/master/setup.py | sudo python3 - uninstall

⚙️ Configuring verpi

Using the configuration file located at ~/.config/verpi/conf.toml you can change the brightness of the lights. By default, the brightness is set to 0.1. To turn the lights off you can set the brightness to 0.0 as seen below:

brightness = 0.0

Below is an example configuration file:

token = "<YOUR VERCEL TOKEN>"
brightness = 0.0

🙌 Contributing

Before contributing please read the CONTRIBUTING.md file.

👥 Contributors

• @gleich