@antelopejs/dms

The AntelopeJS dashboard management system (DMS). It provides an Inertia/Vue admin dashboard, authentication and tenancy, declarative pages and components, data management, file uploads, notifications, and realtime updates.

Its public contracts live in a separate package, @antelopejs/interface-dms: modules import the interfaces from there and never from the runtime.

Installation

ajs project modules add @antelopejs/dms

The dashboard also requires an API module, a module implementing the Database interface, and an authentication module. The frontend is served separately by the ajs dms CLI from @antelopejs/dms-frontend.

Getting started

Start with the installation guide and quickstart. The quickstart uses the maintained template-dms-demo, which includes a complete backend and frontend setup.

Module settings belong in the config block for @antelopejs/dms in antelope.config.ts. See the configuration reference for the verified options and defaults. In production, set strong values for auth.jwtSecret, htmlRender.serviceSecret, and frontend.bootstrapSecret; use Redis for realtime operation across multiple backend instances.

Development

Run from the repository root, which is a pnpm workspace holding this package and packages/interface-dms:

pnpm install
pnpm build
pnpm test