PyPNM-WebUI

Frontend-only web client for PyPNM REST APIs.

Requirements

• Linux, validated on:
  • Ubuntu 22.04 LTS
  • Ubuntu 24.04 LTS

Other modern Linux distributions may work but are not yet part of the test matrix.

Minimum shell dependencies

From a fresh system, install Git:

sudo apt-get update
sudo apt-get install -y git

Get PyPNM-WebUI

git clone https://github.com/PyPNMApps/PyPNM-WebUI.git
cd PyPNM-WebUI

Install

./install.sh

Run locally

pypnm-webui serve

Default local URL:

• http://127.0.0.1:4173

CLI help:

pypnm-webui --help
pypnm-webui serve --help
pypnm-webui config-menu --help
pypnm-webui kill-pypnm-webui --help

Common serve examples:

pypnm-webui serve
pypnm-webui serve --host 0.0.0.0 --port 4173
pypnm-webui serve --open
pypnm-webui config-menu
pypnm-webui kill-pypnm-webui --list
./install.sh --update-webui
npm run docs:build
npm run docs:serve

User docs

• Documentation Index
• Getting Started
• Install And Bootstrap
• Release Helpers
• Runtime Configuration
• Using The UI
• Troubleshooting
• Release Workflow

Development docs

• Development Field Hints
• Git Helpers
• Development Workflow
• Development Logging

Git Save And Versioning

Use ./tools/git/git-save.sh --commit-msg "..." for normal development saves.

The script:

• runs lint, test, and build checks
• bumps the BUILD segment in VERSION
• syncs package.json and package-lock.json
• stages changes
• creates the save commit

This keeps version notation committed and prevents later release failures caused by uncommitted local version bumps.