JSPM

  • Created
  • Published
  • Downloads 1294
  • Score
    100M100P100Q116288F
  • License MIT

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@premieroctet/next-admin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Next Admin

    License Version

    next-admin provides a customizable and turnkey admin dashboard for applications built with Next.js and powered by the Prisma ORM. It aims to simplify the development process by providing a turnkey admin system that can be easily integrated into your project.

    https://next-admin.js.org

    Features

    • 💅 Customizable admin dashboard
    • 💽 Database relationships management
    • 👩🏻‍💻 User management (CRUD operations)
    • 🎨 Dashboard widgets and customizable panels
    • ⚛️ Integration with Prisma ORM
    • 👔 Customizable list and form

    Installation

    To install the library, run the following command:

    yarn add @premieroctet/next-admin prisma-json-schema-generator

    Documentation

    For detailed documentation, please refer to the documentation.

    Usage

    To use the library in your Next.js application, follow these steps:

    1. Create an admin route in your Next.js application.
    2. Add the file [[...nextadmin]].js to the pages/admin directory.
    3. Export the NextAdmin component from the file.
    4. Use getServerSideProps to pass the props from the nextAdminRouter to the NextAdmin component.

    Bonus: Customize the admin dashboard by passing the NextAdminOptions options to the router and customize the admin dashboard by passing dashboard props to NextAdmin component. (More details in the documentation)

    Example

    Here's a basic example of how to use the library:

    import { PrismaClient } from "@prisma/client";
    import schema from "./../../../prisma/json-schema/json-schema.json"; // generated by prisma-json-schema-generator on yarn run prisma generate
    import "@premieroctet/next-admin/dist/styles.css";
    import {
      AdminComponentProps,
      NextAdmin,
      NextAdminOptions,
    } from "@premieroctet/next-admin";
    
    const prisma = new PrismaClient();
    
    export default function Admin(props: AdminComponentProps) {
      return <NextAdmin {...props} />;
    }
    
    export const getServerSideProps: GetServerSideProps = async ({ req, res }) => {
      const { nextAdminRouter } = await import(
        "@premieroctet/next-admin/dist/router"
      );
    
      const adminRouter = await nextAdminRouter(prisma, schema);
      return adminRouter.run(req, res) as Promise<
        GetServerSidePropsResult<{ [key: string]: any }>
      >;
    };

    Demonstration

    You can find the library code in the next-admin repository.

    Also you can find a deployed version of the library here.

    License

    This library is open source and released under the MIT License.