Last updated
Last updated
The "Getting started" section is an overview and quick explanation of AdminJS ecosystem. Detailed instructions for setting up your AdminJS application and connecting it to your database(s) are described in separate guides (scroll down to for quick links).
An AdminJS application consists of:
a core package
a plugin (for a framework of your choice)
an adapter for (for a ORM/ODM of your choice)
As of version 7, AdminJS only supports ESM and will no longer work with CommonJS syntax. When setting up your project you should follow the guidelines from Node.js documentation:
In the most basic scenario, the steps to get started with ESM are:
setting type
to "module"
in your package.json
file,
using import
/export
syntax with explicit .js
extensions instead of require
s,
if using Typescript, you should set moduleResolution
and module
to "nodenext"
and target
to "esnext"
in your tsconfig.json
If you use @adminjs/nestjs
do not update to ESM as NestJS doesn't support ESM as of 2023/04. Instead, please see the so that you can import updated AdminJS packages into your CJS NestJS app.
AdonisJS (and Lucid) integration should be installed using Adonis CLI. Please refer to to see a thorough guide.
@adminjs/cli
provides adminjs create
command which you can use to quickly create your AdminJS application.
NPM:
Yarn:
You may also set up your AdminJS application manually by following the rest of this documentation.
First of all, install the core package:
Next, install one of our plugins:
Finally, install an adapter:
After you have installed AdminJS dependencies, proceed to:
AdminJS needs to generate its own frontend. In the production environment, you would bundle all frontend files during build step of your deployment process, but that would be quite annoying to do in development.
For this reason you should add adminJS.watch()
function call after setting up all plugins and adapters. This only affects development environment (process.env.NODE_ENV === 'development'
) and launches a separate bundling process in the background.
Without this step in development, AdminJS will start but won't display anything useful in the browser (except for some parsing errors in the console).
section for instructions on how to setup AdminJS with your framework.
section for instructions on how to connect your AdminJS instance to your database.