Skip to content

pyMC-dev/pyMC-RepeaterUI

Repository files navigation

pyMC Repeater UI

Web dashboard for pyMC_Repeater — monitor and manage your pyMc repeater entirely from the browser.

Built with Vue 3, TypeScript, and TailwindCSS. This repository holds the standalone UI source; it builds directly into the repeater project and is served by its embedded web server. Keeping the frontend separate keeps the repeater codebase lean and makes UI contributions easier.

Contributing

Pull requests are welcome — please target the dev branch.

Features

  • Dashboard — real-time stats, packet charts, and airtime utilisation at a glance
  • Neighbors — interactive network map (Leaflet) with signal-quality indicators and a sortable neighbor table
  • Terminal — full xterm.js console backed by a command registry (status, identities, keys, neighbors, ACL, rooms, and more)
  • Configuration — radio settings, duty cycle, transport keys, web settings, LetsMesh, backup/restore, API tokens, and advert management
  • Sessions & Companions — view and manage active sessions and companion devices
  • Statistics & Logs — historical packet data, system metrics, and a searchable log viewer
  • Room Servers — overview of connected room servers
  • CAD Calibration — channel-activity-detection tuning tools
  • Real-time updates — WebSocket packet feed with automatic reconnection
  • Authentication — JWT-based login with token refresh and a guided first-boot setup wizard

Prerequisites

Quick Start

npm install
cp .env.example .env.local   # point VITE_DEV_API_URL at your backend
npm run dev

The Vite dev server proxies /api and /auth requests to the URL set in VITE_DEV_API_URL.

Production Build

npm run build

The compiled output is written to ../pyMC_Repeater/repeater/web/html and served directly by the repeater.

Scripts

Command Description
npm run dev Start Vite dev server with HMR
npm run build Type-check and build for production
npm run preview Preview the production build locally
npm run test:unit Run unit tests (Vitest)
npm run lint Lint and auto-fix with ESLint
npm run format Format source with Prettier

Environment Variables

Variable Default Description
VITE_DEV_API_URL http://localhost:8000 Backend URL used by the Vite dev proxy and WebSocket connections

License

MIT

About

Web dashboard for pyMC_Repeater — manage and monitor your MeshCore repeater from the browser

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages