Frontend CLI
The ajs dms binary ships with @antelopejs/dms-frontend, the frontend loader: it fetches the frontend modules your backend serves, assembles them into one Vue workspace, and runs, builds or serves it. It has its own package, release cycle and documentation.
The commands you use while building a dashboard
| Command | When |
|---|---|
ajs dms dev | Day to day, next to ajs project dev -w. Finds the running backend of the project on its own and reloads on every edit. |
ajs dms build -e <env> | Before a deployment: builds the frontend from antelope.config.ts and the installed modules, without a backend. |
ajs dms start -b <url> | In production: serves the built frontend. |
ajs dms clean -b <url> | When a dev workspace is stale: removes the workspace of that backend (--all removes every one). |
# terminal 1: the backend
ajs project dev -w
# terminal 2: the frontend, on http://localhost:3001
ajs dms dev
ajs dms reads the environment of the shell it runs in, and the project's .env files. Releases of the DMS and of the loader go together: DMS 0.10 runs on @antelopejs/dms-frontend 0.8.
Where to go next
Frontend layer
Author a custom Vue frontend module and understand the machine that loads it — the dms.frontend.ts entry, component registration, overrides, configuration, localization, the materialized workspace, and the catch-all renderer.
Distributable module
Package a DMS extension module other projects install.