# premieroctet/next-admin architecture

> Architecture diagram of the GitHub repository premieroctet/next-admin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/premieroctet/next-admin
- Repository: https://github.com/premieroctet/next-admin

## Overview

##### Main Components

a. Core Components:
- Next.js Admin Panel (Central Component)
- Documentation Site
- Example Application
- CLI Tool
- Prisma Generator
- JSON Schema Package

b. Infrastructure Layer:
- Database Integration (Prisma)
- Authentication System
- API Routes
- File Handling System

##### Architecture Breakdown

**┌─ Client Layer ─────────────────────────────────┐**
- Admin UI Components                          │
- Form Handlers                                │
- Data Tables                                  │
- Advanced Search                              │
- ┬───────────────────────────┘

**┌─────────────────────▼───────────────────────────┐**
- Integration Layer                               │
- Route Handlers                                │
- API Endpoints                                 │
- Authentication Middleware                     │
- ┬───────────────────────────┘

**┌─────────────────────▼───────────────────────────┐**
- Data Access Layer                               │
- Prisma Client                                 │
- Model Configurations                          │
- Data Validation                              │
- ┬───────────────────────────┘

**┌─────────────────────▼───────────────────────────┐**
- External Services                               │
- Database                                      │
- File Storage                                 │
- ┘

##### Key Elements to Highlight

a. Package Relationships:
- How `@next-admin/cli` generates boilerplate
- `@next-admin/generator-prisma` integration
- Demonstrate `@next-admin/json-schema` usage

b. Data Flow:
- User interactions → Admin UI
- API requests → Route handlers
- Database operations → Prisma
- File uploads/downloads

c. Core Features:
- CRUD operations
- Advanced search functionality
- Authentication & authorization
- i18n support
- Theming system

##### Implementation Details

- Relationship between app router and page router support
- Plugin system
- Demonstrate how the CLI integrates with the main package
- Configuration flow from options to implementation

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        UI[Admin UI Components]:::ui
        Forms[Form Handlers]:::ui
        Tables[Data Tables]:::ui
        Search[Advanced Search]:::ui
        Theme[Theming System]:::ui
        I18n[i18n Support]:::ui
    end

    subgraph Integration
        Routes[Route Handlers]:::api
        API[API Endpoints]:::api
        Auth[Authentication]:::api
    end

    subgraph Data
        Prisma[Prisma Client]:::data
        Models[Model Configurations]:::data
        Validation[Data Validation]:::data
    end

    subgraph External
        DB[(Database)]:::external
        Storage[(File Storage)]:::external
    end

    subgraph Tools
        CLI[CLI Tool]:::tool
        Generator[Prisma Generator]:::tool
        Schema[JSON Schema Package]:::tool
    end

    subgraph Apps
        Admin[Next.js Admin Panel]:::app
        Docs[Documentation Site]:::app
        Example[Example Application]:::app
    end

    UI --> Routes
    Forms --> API
    Tables --> API
    Search --> API
    Routes --> Auth
    Auth --> Prisma
    API --> Prisma
    Prisma --> DB
    API --> Storage
    CLI --> Admin
    Generator --> Models
    Schema --> Validation

    %% Click Events
    click Admin "https://github.com/premieroctet/next-admin/tree/main/packages/next-admin/"
    click Docs "https://github.com/premieroctet/next-admin/tree/main/apps/docs/"
    click Example "https://github.com/premieroctet/next-admin/tree/main/apps/example/"
    click CLI "https://github.com/premieroctet/next-admin/tree/main/packages/cli/"
    click Generator "https://github.com/premieroctet/next-admin/tree/main/packages/generator-prisma/"
    click Schema "https://github.com/premieroctet/next-admin/tree/main/packages/json-schema/"
    click UI "https://github.com/premieroctet/next-admin/tree/main/packages/next-admin/src/components/"
    click Routes "https://github.com/premieroctet/next-admin/tree/main/packages/next-admin/src/handlers/"
    click Prisma "https://github.com/premieroctet/next-admin/blob/main/packages/next-admin/src/utils/prisma.ts"
    click Forms "https://github.com/premieroctet/next-admin/blob/main/packages/next-admin/src/components/Form.tsx"
    click Search "https://github.com/premieroctet/next-admin/tree/main/packages/next-admin/src/components/advancedSearch/"
    click I18n "https://github.com/premieroctet/next-admin/blob/main/packages/next-admin/src/context/I18nContext.tsx"
    click Auth "https://github.com/premieroctet/next-admin/blob/main/packages/next-admin/src/utils/permissions.ts"
    click API "https://github.com/premieroctet/next-admin/blob/main/packages/next-admin/src/appHandler.ts"
    click Theme "https://github.com/premieroctet/next-admin/blob/main/packages/next-admin/src/context/ColorSchemeContext.tsx"

    %% Styling
    classDef ui fill:#2196F3,stroke:#1565C0,color:white
    classDef api fill:#4CAF50,stroke:#2E7D32,color:white
    classDef data fill:#FFC107,stroke:#FFA000,color:black
    classDef external fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef tool fill:#FF9800,stroke:#F57C00,color:white
    classDef app fill:#607D8B,stroke:#455A64,color:white

    %% Legend
    subgraph Legend
        L1[UI Components]:::ui
        L2[API Services]:::api
        L3[Data Layer]:::data
        L4[External Services]:::external
        L5[Build Tools]:::tool
        L6[Applications]:::app
    end
```
