@antelopejs/dms-frontend

@antelopejs/dms-frontend

The frontend of the AntelopeJS DMS: the ajs dms CLI, the Vue renderer and the frontend-module SDK.

Documentation · DMS · Modules

What it does

• Asks a DMS backend which frontend modules it loads, materializes them into a generated workspace, builds it, and runs the frontend server.
• Renders the dashboard with Vue 3, Vite, Inertia and server-side rendering.
• Keeps the backend token on the server: the browser only holds a sealed, HttpOnly session cookie, and declared backend prefixes are proxied with the session's token.
• Lets a module extend the dashboard with pages, components and plugins (dms.frontend.ts), server routes (dms.server.ts) and build-time declarations (dms.frontend.build.ts).
• Serves development with hot reload, and production with pre-compressed assets.

Install

Add the package next to @antelopejs/core; the core ajs command runs it as ajs dms:

pnpm add -D @antelopejs/core @antelopejs/dms-frontend

Quick start

In a DMS project started with ajs project run -w, serve the dashboard with hot reload:

pnpm exec ajs dms dev

For production, build against the backend, then start the frontend server, with DMS_SESSION_SECRET and DMS_BOOTSTRAP_SECRET set:

pnpm exec ajs dms build -b https://dms.example.com
pnpm exec ajs dms start -b https://dms.example.com -p 3001

ajs dms --help lists every command, and ajs dms help environment every environment variable.

Compatibility

The 0.6 line needs Node.js 20.12 or later and @antelopejs/core >=1.13.2 <2. The compatibility table lists every release.

Documentation

• Introduction and Installation
• CLI reference
• Configuration and environment variables
• Writing a frontend module
• Rendering model
• Deploying to production
• Troubleshooting

The guide's sources live in docs/. The package also ships the dms-frontend skill for coding agents in skills/, declared under antelopeJs.skills.

Contributing

Read CONTRIBUTING.md before opening a pull request.

pnpm install
pnpm build
pnpm lint          # oxlint, oxfmt, interface ranges and the docs reference check
pnpm typecheck
pnpm test

pnpm docs:reference regenerates the environment-variable table of docs/4.configuration.md from the list ajs dms help environment prints; pnpm lint fails when the table is stale.

License

Apache-2.0