Getting started
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 Setup 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)
First of all, install the core package:
$ yarn add adminjs
Next, install one of our plugins:
$ yarn add @adminjs/express # for Express server
$ yarn add @adminjs/nestjs # for Nest server
$ yarn add @adminjs/hapi # for Hapi server
$ yarn add @adminjs/koa # for Koa server
$ yarn add @adminjs/fastify # for Fastify server
Finally, install an adapter:
$ yarn add @adminjs/typeorm # for TypeORM
$ yarn add @adminjs/sequelize # for Sequelize
$ yarn add @adminjs/mongoose # for Mongoose
$ yarn add @adminjs/prisma # for Prisma
$ yarn add @adminjs/mikroorm # for MikroORM
$ yarn add @adminjs/objection # for Objection
$ yarn add @adminjs/sql # for raw SQL, currently supports only Postgres
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.import AdminJS from 'adminjs'
const adminJS = new AdminJS({
// ...
})
adminJS.watch()
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).
Last modified 2mo ago