@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

• Reads the frontend modules of an AntelopeJS project, materializes them into a generated workspace, builds it, and runs the frontend server.
• Renders the dashboard with Vue, Vite, Inertia and server-side rendering.
• Keeps the backend token on the server. The browser only holds a sealed, HttpOnly session cookie, and the server adds the session's token to each request it proxies to a declared backend prefix.
• 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 dev -w, serve the dashboard with hot reload:

pnpm exec ajs dms dev

For production, build from the project root, without the backend. Then start the frontend server with DMS_SESSION_SECRET and the backend's secrets set:

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

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

Compatibility

Each DMS release declares the renderer releases it runs on in engines["@antelopejs/dms-frontend"] of its frontend module's package.json. The ajs dms CLI refuses to build a module whose range excludes the installed renderer. To find the renderer releases that match a DMS release, read that engines range in the installed DMS frontend module, as the Compatibility section of the introduction explains. The renderer needs the @antelopejs/core range in the table above, and the engines field of its package.json sets the Node.js versions it runs on.

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, interface ranges, the docs reference check and the source checks
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