https://github.com/boneskull/uebersicht-harness
Testing harness for Uebersicht widgets
https://github.com/boneskull/uebersicht-harness
ubersicht uebersicht
Last synced: about 2 months ago
JSON representation
Testing harness for Uebersicht widgets
- Host: GitHub
- URL: https://github.com/boneskull/uebersicht-harness
- Owner: boneskull
- License: blueoak-1.0.0
- Created: 2025-12-23T01:59:18.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-03-05T20:43:41.000Z (3 months ago)
- Last Synced: 2026-03-05T23:38:59.446Z (3 months ago)
- Topics: ubersicht, uebersicht
- Language: JavaScript
- Homepage:
- Size: 1010 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Übersicht Harness
> A development/testing harness for [Übersicht](http://tracesof.net/uebersicht/) widgets. Run & debug your widgets in a browser with hot reload!
## Quick Start
This will start a development server you can hit to debug your widgets:
```bash
npx uebersicht-harness
```
You could install globally, if you are so inclined:
```bash
npm install -g uebersicht-harness
uebersicht-harness
```
## Configuration
### Widgets Directory
By default, widgets are loaded from `~/Library/Application Support/Übersicht/widgets`.
If you've changed the location of your widgets, override with the `UEBERSICHT_WIDGETS_DIR` environment variable:
```bash
UEBERSICHT_WIDGETS_DIR=/path/to/widgets npx uebersicht-harness
```
### Widget Requirements
Widgets must have an `index.jsx` entry point. Directories starting with `_` or `.` are ignored.
CoffeeScript-based widgets are unsupported.
### CORS Proxy
Übersicht is a desktop app without browser security restrictions. Widgets can freely `fetch()` from `localhost:8080`, `localhost:3000`, etc. In this browser-based harness, those requests would normally be blocked by CORS.
The harness automatically intercepts `fetch()` calls to `localhost` and routes them through Vite's proxy server, bypassing CORS. This works out of the box for common ports: 3000, 4000, 5000, 8000, 8080, 9000.
To add additional ports:
```bash
UEBERSICHT_PROXY_PORTS=3000,8080,12345 npx uebersicht-harness
```
## License
Copyright © 2025 [Christopher "boneskull" Hiller](https://github.com/boneskull). Licensed Blue Oak Model License 1.0.0.