Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 2.73 KB

README.md

File metadata and controls

106 lines (73 loc) · 2.73 KB
Raw

adminjs-prisma

This is an official AdminJS adapter which integrates Prisma into AdminJS.

Installation

  • yarn: yarn add @adminjs/prisma

  • npm: npm install @adminjs/prisma

Usage

The plugin can be registered using standard AdminJS.registerAdapter method.

import { Database, Resource } from '@adminjs/prisma'
import AdminJS from 'adminjs'

AdminJS.registerAdapter({ Database, Resource })

Example

Whole code can be found in example-app directory in the repository.

import express from 'express'
import AdminJS from 'adminjs'
import AdminJSExpress from '@adminjs/express'
import { Database, Resource } from '@adminjs/prisma'
import { PrismaClient } from '@prisma/client'
import { DMMFClass } from '@prisma/client/runtime'

const PORT = process.env.port || 3000

const prisma = new PrismaClient()

AdminJS.registerAdapter({ Database, Resource })

const run = async () => {
  const app = express()

  // `_baseDmmf` contains necessary Model metadata. `PrismaClient` type doesn't have it included
  const dmmf = ((prisma as any)._baseDmmf as DMMFClass)

  const admin = new AdminJS({
    resources: [{
      resource: { model: dmmf.modelMap.Post, client: prisma },
      options: {},
    }, {
      resource: { model: dmmf.modelMap.Profile, client: prisma },
      options: {},
    }, {
      resource: { model: dmmf.modelMap.User, client: prisma },
      options: {},
    }],
  })

  const router = AdminJSExpress.buildRouter(admin)

  app.use(admin.options.rootPath, router)

  app.listen(PORT, () => {
    console.log(`Example app listening at http://localhost:${PORT}`)
  })
}

run()
  .finally(async () => {
    await prisma.$disconnect()
  })

ManyToOne / ManyToMany

These relationships are currently not supported by default. You can manage them using custom actions and components.

Pull request

Before you make a PR make sure all tests pass and your code won't cause linter errors. You can do this by running:

yarn lint

To run test do next:

1. cp .env.example .env
2. docker-compose up -d
3. yarn prisma-migrate
4. yarn test

License

AdminJS is copyrighted © 2023 rst.software. It is a free software, and may be redistributed under the terms specified in the LICENSE file.

About rst.software

We’re an open, friendly team that helps clients from all over the world to transform their businesses and create astonishing products.

  • We are available for hire.
  • If you want to work for us - check out the career page.