@antelopejs/dms

@antelopejs/dms

Admin dashboards for AntelopeJS, declared in TypeScript on the backend.

Documentation · Modules · Frontend

What it does

• Declares pages as TypeScript classes: forms, tables, charts and layouts are blocks the shared Vue renderer draws, with no Vue to write for standard screens.
• Handles sign-in, members, roles and permissions down to each block, multi-tenancy and a SaaS mode.
• Manages data through data controllers and table views, with file uploads, notifications and realtime updates.
• Grows with installable modules: an AI assistant, a page builder, database and API consoles, automations, SaaS billing, translations, mailing, marketing analytics and a media library.
• Ships Claude Code skills (dms, dms-best-practices, dms-pages…) so coding agents build pages the way the DMS expects.

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

Install

For a new application, start from the template in the quick start below. To add the DMS to an existing AntelopeJS project, add the module and the dashboard's frontend loader:

ajs project modules add @antelopejs/dms
pnpm add -D @antelopejs/dms-frontend

The DMS also needs an API module, a module implementing the database interface, and an authentication module: see Installation. Its settings belong in the config block of @antelopejs/dms in antelope.config.ts (Configuration). In production, set clientBaseUrl and strong values for auth.jwtSecret, htmlRender.serviceSecret and frontend.bootstrapSecret (the DMS refuses to start without the first three), and use Redis for realtime across several backend instances.

Quick start

Clone template-dms-demo, which loads the DMS, its companions and a seeded demo application. It needs Node.js 22, pnpm and a MongoDB on localhost:27017.

git clone https://github.com/AntelopeJS/template-dms-demo.git my-app
cd my-app
pnpm install
pnpm --dir frontend-vue install
cat > .env <<EOF
DMS_API_BASE_URL=http://localhost:5010
DMS_SESSION_SECRET=$(openssl rand -hex 32)
EOF
pnpm exec ajs project modules install
pnpm dev            # backend on http://localhost:5010
pnpm frontend:dev   # dashboard on http://localhost:3001, in a second terminal

Open http://localhost:3001 and create the first administrator. A page is a class whose static fields are blocks:

import { PageController, RegisterPage, pagesCategory } from "@antelopejs/interface-dms/page";
import { KpiCard } from "@antelopejs/interface-dms/base/kpi-card";

@RegisterPage()
export class SalesPage extends PageController("sales", {
  displayName: "Sales",
  icon: "i-ph-chart-line",
  category: pagesCategory,
}) {
  static revenue = KpiCard({ title: "Revenue", fetchUrl: "/api/sales/revenue" });
}

Compatibility

Embedded / AdonisJS 6: tested with @antelopejs/core 1.15.2, @antelopejs/dms 0.9.2 and @antelopejs/dms-frontend 0.6.1 in an AdonisJS 6 application (see Run the DMS inside AdonisJS).

@antelopejs/dms 0.9.2 needs @antelopejs/core >=1.15.2 <2 (its peer dependency). Every renderer release is listed in the frontend's compatibility table.

Documentation

• Getting started: installation, quickstart, tutorial, architecture
• Building: configuration, pages and components, navigation, localization, deployment
• Auth and tenancy
• Components: every block, with a live preview
• Interfaces: the @antelopejs/interface-dms reference
• AI and Claude Code: the skill suite and the AI assistant
• Modules and Frontend

The runtime guides live in docs/. The canonical contract reference belongs to @antelopejs/interface-dms, not this runtime package.

The package ships the core Claude Code skills (dms, dms-auth, dms-best-practices, dms-module, dms-pages, dms-project) in skills/, declared under antelopeJs.skills; Install the plugin to use them.

Contributing

This package lives in the AntelopeJS/dms pnpm workspace, next to @antelopejs/interface-dms. Read CONTRIBUTING.md and the repository README for the development commands.

Third-party data

The package ships the DB-IP IP to Country Lite database (data/) to tell which country a sign-in came from. It is licensed under the Creative Commons Attribution 4.0 International License: IP Geolocation by DB-IP. pnpm country-database downloads the current edition; packing the package for a release runs it.

License

Apache-2.0