← All Plugins/System & Automation/v0.1.0

Veap Setup Wizard

Official

Interactive web-based setup wizard for first-time application configuration, database connection testing, and root admin creation.

bun veap add @veap/installer-plugin

Purpose & Overview

Listens for 'system:not-installed' events and automatically redirects unconfigured visits to /install until setup is completed.

Installation & Setup

1

Install the package

bash
bun veap add @veap/installer-plugin
2

Register in lib/veap.ts (or auto via lib/plugins.gen.ts)

lib/veap.ts
typescript
// lib/veap.ts
import { Application } from "@veap/core/core/server";
import installerPlugin from "@veap/installer-plugin";

export const app = Application.configure()
  .withPlugins([installerPlugin])
  .create();

Keep in mind

  • Automatically redirects visitors to the `/install` setup wizard if no administrator account exists.
  • Guides through configuring encryption keys, database connections, and running initial migrations.
  • Automatically locks itself after successful installation to prevent unauthorized re-execution.

Dependencies

Veap Core

@veap/core (^0.1.0)

NPM Packages
  • react-hook-form@^7.54.0
  • zod@^4.4.3
  • lucide-react@^1.27.0

Authors & Maintainers

Veap Core Team

Maintainer

Profile →

Specifications

License
MIT
Type
plugin
Status
official
Repository
GitHub →
Issues
Report issue →
veap
Preparing0%