k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-19 13:36:48 +00:00

Files

T

mauriceboe 0a5c8be83d docs(plugins): plugin wiki + reference plugin (M7)

- Wiki pages (sync to the GitHub wiki on push to main): Plugins overview + trust
  model, Plugin Development (SDK, definePlugin, ctx, routes/jobs, the client
  bridge, testing with the mock host), Plugin Permissions reference, and
  Publishing (registry PR + CI gates + provenance). Linked from the sidebar.
- Reference plugin plugin-sdk/examples/trip-countdown: a complete, minimal-
  permission widget (reads trip data through ctx, renders in the sandboxed
  iframe via the bridge, filled-in README). Validated in the SDK test suite so it
  passes the exact gate authors face.

2026-07-03 17:55:07 +02:00

1.2 KiB

Raw Blame History

Trip Countdown

A dashboard widget that counts down the days to your next trip.

What it does

Trip Countdown adds a small dashboard widget showing how many days remain until your upcoming trip starts. When a trip is under way it shows "in progress" instead. It's the reference plugin for the TREK plugin system — a minimal but complete widget that reads trip data through the sandbox and renders it in an isolated iframe.

Screenshots

Permissions

Permission	Why this plugin needs it
`db:read:trips`	To read the current trip's start date so it can compute the countdown. The read is membership-checked by TREK, so the widget only ever sees a trip you already have access to.

It requests no network access and stores no data of its own.

Setup

None. Enable plugins on your instance (TREK_PLUGINS_ENABLED=true), install and activate Trip Countdown, and the widget appears on your dashboard.

Building

The widget ships plain JS/HTML — no build step. server/index.js is the plugin entry; client/index.html is the widget iframe.

License

MIT — see the TREK repository.

1.2 KiB Raw Blame History