■□

Install The Shelf on a computer

One line, straight from GitHub. It gets the newest version and opens the usual setup page in your browser, where you pick where it goes and whether it starts by itself. Updating an existing install the same way keeps your shelves, notes and messages.

Pick your computer

Windows 10 / 11

Open PowerShell (Start menu, type PowerShell), paste this and press Enter. If Node.js isn't installed yet, it installs it for you with winget.

irm https://raw.githubusercontent.com/hardwaremack-prog/the-shelf/main/install.ps1 | iex

Mac, Linux, Raspberry Pi

Open Terminal, paste this and press Enter. On a Raspberry Pi or other Debian/Ubuntu system it installs Node.js with apt if needed (it asks for your password); on a Mac it uses Homebrew if you have it.

curl -fsSL https://raw.githubusercontent.com/hardwaremack-prog/the-shelf/main/install.sh | bash

Or download it

The whole Shelf as a zip. Unzip it and run Install (Windows).bat, Install (Mac).command or Install (Linux).sh from its installer folder (Node.js needed: nodejs.org).

Download The Shelf (.zip)

After it's installed

  1. The Shelf opens at http://localhost:8080. Other phones and computers on your Wi-Fi use the address shown at the bottom of its sidebar.
  2. New versions: click Check for updates at the bottom of the sidebar, then Update now. It downloads from GitHub and restarts itself; your files stay.
  3. Mesh Coms (under Tools) joins the text mesh of your Heltec and ESP32 boards, through a board on the same Wi-Fi.

The Shelf on a Heltec V3/V4 or a plain ESP32 board is installed from the board installer. Source: github.com/hardwaremack-prog/the-shelf.