nuxt-observe

Self-hosted observability + service-registry dashboard module for Nuxt.

• ✨  Release Notes

Features

• 📊  Self-hosted observability dashboard, mounted at a configurable prefix
• 🩺  Health endpoint under /api/observe
• 🧩  Zero-config: works out of the box, tune via the observe key or nuxt-observe.config.ts

Quick Setup

Install the module in your Nuxt application:

npx nuxt module add nuxt-observe

Then open the dashboard at /observe (change the mount path via observe.prefix).

Documentation

Full documentation lives in docs/ and is built with VitePress:

# Start the docs dev server
pnpm docs:dev

# Build the static docs site
pnpm docs:build

# Preview the built site
pnpm docs:preview

Repository layout

The source is a Nuxt module under src/: src/module.ts wires everything through @nuxt/kit, and src/runtime/ splits into app/ (the Vue dashboard), server/ (the Nitro backend), and shared/ (framework-light schema, RBAC, and types).

Every major area carries an AGENTS.md (a deep, self-contained reference for contributors and coding agents) alongside a short README.md. Start from the top-level map in AGENTS.md, which links to the server, API, auth, migrations, dashboard, components, composables, schema, RBAC, and test area docs. Human-facing narrative documentation lives under docs/.

Contribution

# Install dependencies
pnpm install

# Generate type stubs
pnpm dev:prepare

# Develop with the playground
pnpm dev

# Build the playground
pnpm dev:build

# Run ESLint
pnpm lint

# Run the fast unit suite (Vitest, node env)
pnpm test
pnpm test:watch

# Run the Nuxt integration suite (boots the fixture app, exercises the endpoints)
pnpm test:nuxt

# Run the Playwright dashboard e2e suite (needs `npx playwright install chromium` once)
pnpm test:e2e

# Release new version
pnpm release