Purpose & Overview
Serves as the central administration control plane for Veap applications. Allows other plugins to register sidebar items, dashboard widgets, and settings screens dynamically.
Installation & Setup
1
Install the package
bash
bun veap add @veap/panel-plugin2
Register in lib/veap.ts (or auto via lib/plugins.gen.ts)
lib/veap.ts
typescript
// lib/veap.ts
import { Application } from "@veap/kernel";
import panelPlugin from "@veap/panel-plugin";
import { plugins } from "./plugins.gen";
export const app = Application.configure()
.withDatabase()
.withAuth()
.withRouter()
.withPlugins(plugins)
.create();3
Start application
bash
bun devMigrations run automatically on boot via MigrationServiceProvider.
Keep in mind
- The main dashboard path is configured via `privatePath` in `veap.config.ts` (default: `/app`).
- Other plugins can inject dashboard widgets using the `widgets` property in their IPlugin manifest.
- Integrates with @veap/rbac-plugin to filter menu items based on authenticated user roles.
Dependencies
Veap Kernel
@veap/kernel (^0.1.0)
Required Veap Plugins
NPM Packages
@iconify/react@^5.2.0lucide-react@^1.27.0sonner@^2.0.0zod@^4.4.3
Authors & Maintainers
Veap Core Team
Maintainer