Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/premieroctet/next-admin
▲ Full-featured admin for Next.js and Prisma
https://github.com/premieroctet/next-admin
admin hacktoberfest nextjs prisma typescript
Last synced: about 8 hours ago
JSON representation
▲ Full-featured admin for Next.js and Prisma
- Host: GitHub
- URL: https://github.com/premieroctet/next-admin
- Owner: premieroctet
- License: mit
- Created: 2023-06-28T16:10:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-07T15:32:31.000Z (7 days ago)
- Last Synced: 2024-11-07T16:32:53.169Z (7 days ago)
- Topics: admin, hacktoberfest, nextjs, prisma, typescript
- Language: TypeScript
- Homepage: https://next-admin.js.org
- Size: 3.84 MB
- Stars: 313
- Watchers: 9
- Forks: 16
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Next Admin
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/@premieroctet/next-admin)
`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](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
- ⚙️ Supports App Router and Page Router
## Installation
### With the CLI
```shell copy
npx @premieroctet/next-admin-cli@latest init
```
### Manually
To install the library, run the following command:
```shell copy
yarn add @premieroctet/next-admin @premieroctet/next-admin-generator-prisma
```
## Documentation
For detailed documentation, please refer to the [documentation](https://next-admin-docs.vercel.app/).
## Usage
To use the library in your Next.js application, follow these steps:
1. Add tailwind preset to your `tailwind.config.js` file - [more details](http://next-admin-docs.vercel.app/docs/getting-started#tailwindcss)
2. Add json schema generator to your Prisma schema file - [more details](http://next-admin-docs.vercel.app/docs/getting-started#prisma)
3. Generate the schema with `yarn run prisma generate`
4. Create a catch-all segment page `page.tsx` in the `app/admin/[[...nextadmin]]` folder - [more details](http://next-admin-docs.vercel.app/docs/getting-started#page-nextadmin)
5. Create an catch-all API route `route.ts` in the `app/api/[[...nextadmin]]` folder - [more details](http://next-admin-docs.vercel.app/docs/getting-started#api-route-nextadmin)
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](http://next-admin-docs.vercel.app/docs/getting-started#next-admin-options---optional))
## What does it look like?
An example of `next-admin` options:
```tsx
// app/admin/options.ts
import { NextAdminOptions } from "@premieroctet/next-admin";
export const options: NextAdminOptions = {
title: "⚡️ My Admin Page",
model: {
User: {
toString: (user) => `${user.name} (${user.email})`,
title: "Users",
icon: "UsersIcon",
list: {
search: ["name", "email"],
filters: [
{
name: "is Admin",
active: false,
value: {
role: {
equals: "ADMIN",
},
},
},
],
},
},
Post: {
toString: (post) => `${post.title}`,
},
Category: {
title: "Categories",
icon: "InboxStackIcon",
toString: (category) => `${category.name}`,
list: {
display: ["name", "posts"],
},
edit: {
display: ["name", "posts"],
},
},
},
pages: {
"/custom": {
title: "Custom page",
icon: "AdjustmentsHorizontalIcon",
},
},
externalLinks: [
{
label: "Website",
url: "https://www.myblog.com",
},
],
sidebar: {
groups: [
{
title: "Users",
models: ["User"],
},
{
title: "Categories",
models: ["Category"],
},
],
},
};
```
## 📄 Documentation
For detailed documentation, please refer to the [documentation](https://next-admin-docs.vercel.app/).
## 🚀 Demonstration
You can find the library code in the [next-admin](https://github.com/premieroctet/next-admin) repository.
Also you can find a deployed version of the library [here](https://next-admin-po.vercel.app/).
## Sponsors
This project is being developed by [Premier Octet](https://www.premieroctet.com), a Web and mobile agency specializing in React and React Native developments.
## License
This library is open source and released under the [MIT License](https://opensource.org/licenses/MIT).