[data-reveal]{opacity:1!important;transform:none!important}
AntelopeJSDMS
Getting Started

Installation

Everything to install before your first DMS page — Node, the ajs CLI, a database and Redis, and the acms frontend loader.

The DMS runs on the AntelopeJS toolchain plus two pieces of infrastructure. Set these up once; every guide in this documentation assumes they are in place.

What you need

ToolVersionRole
Node.js20 LTS or newerRuns the backend and the frontend build.
ajs CLIlatestThe AntelopeJS CLI — runs your backend project.
Database—Any module implementing the interface-database contract backs the DMS models.
Redis7.xRealtime pub/sub and caching. Optional on a single dev instance, recommended everywhere.
Docker—Runs the database and Redis in development. Any install works; Docker is the quickest.
acms CLIlatestThe DMS frontend loader — serves the dashboard.

Install Node.js and the ajs CLI

Install Node 20 LTS (or newer) with your usual method, then install the AntelopeJS CLI globally:

Terminal
npm install -g @antelopejs/core
ajs --help   # verify the CLI answers

ajs is pure AntelopeJS — scaffolding, running, and watching projects are covered by the AntelopeJS documentation, not here.

Start a database and Redis

The DMS models run on any database module that implements the AntelopeJS interface-database contract — MongoDB is not required, it is just what these docs use in every example. Any install works; the quickest is Docker. Drop a compose file at the root of your project and start both:

docker-compose.yml
services:
  mongo:
    image: mongo:8
    ports:
      - "27017:27017"
  redis:
    image: redis:7
    ports:
      - "6379:6379"
Terminal
docker compose up -d

The connection URLs these expose (mongodb://127.0.0.1:27017, redis://localhost:6379) are the defaults used throughout the docs' antelope.config.ts examples. Many projects fold this into their dev script: docker compose up -d && ajs project dev -w.

Get the acms frontend loader

The dashboard frontend is served by the acms CLI, shipped by the @antelopejs-private/cms-nuxt package. Add it to your project as a dev dependency — its acms binary is then available to npm scripts and npx:

Terminal
npm install -D @antelopejs-private/cms-nuxt
npx acms --help   # verify
package.json — the conventional script
"scripts": {
  "frontend:dev": "acms dev"
}

The CLI's commands and flags (dev, build, start, prepare, clean) are documented in Frontend CLI.

Optional dependencies

Two features rely on modules the base stack does not include. Install each when you reach the feature — the docs flag the dependency where it applies:

DependencyNeeded forDoc
An interface-email implementation — @antelopejs/nodemailer (ethereal: true in dev)Invites, email validation, 2FA codes, password resetsBackend services
A module implementing the interface-file-storage contract (avoid local-disk storage in production)The file/image field typesFile storage

Where to go next

With the toolchain in place, you are ready to build.

Quickstart

From an empty project to a rendered admin page in five minutes.

Tutorial

Build a small CRM and touch every core concept along the way.

Introduction

What the AntelopeJS DMS is, what ships out of the box, who it is for, and what to know before you start.

Quickstart

Go from an empty project to a rendered admin page in five minutes, writing no Vue.