# dionnieteh/dockit architecture

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

- Interactive diagram: https://gitdiagram.com/dionnieteh/dockit
- Repository: https://github.com/dionnieteh/dockit

## Overview

##### Project type and purpose
- This is a full-stack, monolithic web application built on Next.js (App Router).
- It implements a user dashboard for managing “docking” jobs (preparing ligands/receptors for computational docking), with authentication, user/admin roles, job submission/history, parameter configuration, and file download.
- It uses Prisma (with migrations) for database access and Supabase for authentication/storage, and embeds two Python scripts for preprocessing (prepare_ligand4.py, prepare_receptor4.py).

##### File structure
- Top-level config: Dockerfile, docker-compose.yml, Prisma schema/migrations, Supabase client/server code, Tailwind & ESLint configs.
- src/app: UI routes (page.tsx under /login, /signup, /docking, /history, /admin, etc.).
- src/app/api: Next.js API Route handlers (serverless endpoints) under /admin/*, /login, /register, /job, /dock, /download, /forgot-password, etc.
- src/components: React UI components (dashboard shell, nav, forms, table, toasts, theme provider) and a large reusable UI-kit under components/ui.
- src/lib: Business logic modules (job-status, users, receptors, parameters, Supabase clients, Prisma client, utils, toast-messages, user context/role hooks).
- src/scripts: Python scripts for ligand/receptor preparation.
- prisma: DB schema.prisma, migrations, seed.js.

##### Readme insights
- Standard Next.js deploy on Vercel using App Router.
- Dependencies: Next.js, Prisma, Tailwind CSS, Supabase, Python for scripts.

##### Main components and their relationships
a. Frontend (Browser)
- React UI (pages in src/app)
- UI components (src/components/*, CSS, assets)
b. API Layer (Next.js Server)
- Next.js App Router & Middleware (middleware.ts)
- API Routes (src/app/api/**)
- Business logic modules (src/lib/**)
c. Database
- PostgreSQL (or similar) via Prisma ORM
- Migrations/seed under prisma/
d. Authentication & Storage
- Supabase (auth, possibly file storage) via supabase-client & supabase-server modules
e. Background Processing
- Python scripts invoked by the backend for task preparation
- Could be executed synchronously or via a job queue (depending on implementation)
f. External Services
- Vercel (hosting), Docker containers (local development), optional object storage if used

##### Architectural patterns & principles
- Monolithic layered architecture: separation of concerns between UI, API, data access.
- React component hierarchy with a shared UI-kit.
- “API Routes as micro-endpoints”: each resource under src/app/api has its own route.ts.
- Prisma as single source of truth for DB schema, migrations, queries.
- Supabase for user sessions and possibly real-time or storage.
- Python scripts encapsulated separately (could be a worker component).

##### Elements
- Clear labels (e.g., “Authentication Service (Supabase)”, “Prisma ORM → PostgreSQL”).
- Arrowheads showing request/response directions.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client
    Browser["User Browser"]:::frontend

    %% Next.js Server
    subgraph "Next.js Server (App Router)"
        direction TB

        subgraph "Frontend (SSR/SSG)"
            direction TB
            Layout["layout.tsx"]:::frontend
            PageRoot["page.tsx"]:::frontend
            LoginPage["login/page.tsx"]:::frontend
            SignupPage["signup/page.tsx"]:::frontend
            ForgotPage["forgot-password/page.tsx"]:::frontend
            ResetPage["reset-password/page.tsx"]:::frontend
            DockPage["docking/page.tsx"]:::frontend
            HistoryPage["history/page.tsx"]:::frontend
            AdminPage["admin/page.tsx"]:::frontend
        end

        subgraph "API Routes"
            direction TB
            APILogin["login/route.ts"]:::api
            APIRegister["register/route.ts"]:::api
            APILogout["logout/route.ts"]:::api
            APIMe["me/route.ts"]:::api
            APIForgot["forgot-password/route.ts"]:::api
            APIReset["reset-password/route.ts"]:::api
            APIJob["job/[userId]/route.ts"]:::api
            APIDock["dock/route.ts"]:::api
            APIDownload["download/[id]/route.ts"]:::api
            APIAdminUsers["admin/users/route.ts"]:::api
            APIAdminUserID["admin/users/[id]/route.ts"]:::api
            APIAdminReceptors["admin/receptors/route.ts"]:::api
            APIAdminReceptorID["admin/receptors/[id]/route.ts"]:::api
            APIAdminParams["admin/parameters/route.ts"]:::api
            APIAdminJobs["admin/jobs/route.ts"]:::api
            APIAdminJobID["admin/jobs/[id]/route.ts"]:::api
        end

        subgraph "Business Logic (src/lib)"
            direction TB
            LibPrisma["prisma.ts"]:::logic
            LibSupClient["supabase-client.ts"]:::logic
            LibSupServer["supabase-server.ts"]:::logic
            LibUsers["users.ts"]:::logic
            LibReceptors["receptors.ts"]:::logic
            LibJobs["jobs.ts"]:::logic
            LibParams["param.ts"]:::logic
            LibJobStatus["job-status.ts"]:::logic
            LibToast["toast-messages.ts"]:::logic
            LibUserContext["user-context.tsx"]:::logic
            LibUserRole["user-role.ts"]:::logic
            LibUtils["utils.ts"]:::logic
        end

        subgraph "UI Components (src/components)"
            direction TB
            DashboardShell["dashboard-shell.tsx"]:::component
            DashboardNav["dashboard-nav.tsx"]:::component
            DashboardHeader["dashboard-header.tsx"]:::component
            JobConfig["job-configuration.tsx"]:::component
            JobHistory["job-history.tsx"]:::component
            ParamConfig["parameter-configuration.tsx"]:::component
            ReceptorMgmt["receptor-management.tsx"]:::component
            FileUpload["file-upload.tsx"]:::component
            ToastWrapper["toast-wrapper.tsx"]:::component
            ThemeProvider["theme-provider.tsx"]:::component
            UIkit["components/ui/*"]:::component
        end
    end

    %% External Services & Data Stores
    DB["PostgreSQL Database"]:::db
    SupabaseAuth["Supabase Auth & Storage"]:::external
    PythonWorker["Python Worker (prepare scripts)"]:::worker

    %% Connections
    Browser -->|"HTTP GET"| PageRoot
    Browser -->|"HTTP GET"| LoginPage
    Browser -->|"REST fetch"| APILogin
    Browser -->|"REST fetch"| APIDock

    APILogin -->|"uses"| LibUsers
    APIDock -->|"uses"| LibJobs
    APIDock -->|"invokes"| PythonWorker
    APIGroupCalls[/"API Routes Call Lib"/]:::api --> LibPrisma
    APIGroupCalls --> LibSupServer
    APIGroupCalls --> LibUtils

    LibPrisma -->|"Prisma Client"| DB
    LibSupClient -->|"auth/storage"| SupabaseAuth
    LibSupServer -->|"auth"| SupabaseAuth

    %% Docker Compose Group
    subgraph "Local Dev (Docker Compose)"
        direction TB
        DNext["Next.js App Container"]:::external
        DDB["DB Container"]:::external
        DWorker["Python Worker Container"]:::external
    end

    DNext --> DB
    DNext --> PythonWorker

    %% Click Events - Frontend Pages
    click Layout "https://github.com/dionnieteh/dockit/blob/main/src/app/layout.tsx"
    click PageRoot "https://github.com/dionnieteh/dockit/blob/main/src/app/page.tsx"
    click LoginPage "https://github.com/dionnieteh/dockit/blob/main/src/app/login/page.tsx"
    click SignupPage "https://github.com/dionnieteh/dockit/blob/main/src/app/signup/page.tsx"
    click ForgotPage "https://github.com/dionnieteh/dockit/blob/main/src/app/forgot-password/page.tsx"
    click ResetPage "https://github.com/dionnieteh/dockit/blob/main/src/app/reset-password/page.tsx"
    click DockPage "https://github.com/dionnieteh/dockit/blob/main/src/app/docking/page.tsx"
    click HistoryPage "https://github.com/dionnieteh/dockit/blob/main/src/app/history/page.tsx"
    click AdminPage "https://github.com/dionnieteh/dockit/blob/main/src/app/admin/page.tsx"

    %% Click Events - UI Components
    click DashboardShell "https://github.com/dionnieteh/dockit/blob/main/src/components/dashboard-shell.tsx"
    click DashboardNav "https://github.com/dionnieteh/dockit/blob/main/src/components/dashboard-nav.tsx"
    click DashboardHeader "https://github.com/dionnieteh/dockit/blob/main/src/components/dashboard-header.tsx"
    click JobConfig "https://github.com/dionnieteh/dockit/blob/main/src/components/job-configuration.tsx"
    click JobHistory "https://github.com/dionnieteh/dockit/blob/main/src/components/job-history.tsx"
    click ParamConfig "https://github.com/dionnieteh/dockit/blob/main/src/components/parameter-configuration.tsx"
    click ReceptorMgmt "https://github.com/dionnieteh/dockit/blob/main/src/components/receptor-management.tsx"
    click FileUpload "https://github.com/dionnieteh/dockit/blob/main/src/components/file-upload.tsx"
    click ToastWrapper "https://github.com/dionnieteh/dockit/blob/main/src/components/toast-wrapper.tsx"
    click ThemeProvider "https://github.com/dionnieteh/dockit/blob/main/src/components/theme-provider.tsx"
    click UIkit "https://github.com/dionnieteh/dockit/tree/main/src/components/ui/"

    %% Click Events - API Routes
    click APILogin "https://github.com/dionnieteh/dockit/blob/main/src/app/api/login/route.ts"
    click APIRegister "https://github.com/dionnieteh/dockit/blob/main/src/app/api/register/route.ts"
    click APILogout "https://github.com/dionnieteh/dockit/blob/main/src/app/api/logout/route.ts"
    click APIMe "https://github.com/dionnieteh/dockit/blob/main/src/app/api/me/route.ts"
    click APIForgot "https://github.com/dionnieteh/dockit/blob/main/src/app/api/forgot-password/route.ts"
    click APIReset "https://github.com/dionnieteh/dockit/blob/main/src/app/api/reset-password/route.ts"
    click APIJob "https://github.com/dionnieteh/dockit/blob/main/src/app/api/job/[userId]/route.ts"
    click APIDock "https://github.com/dionnieteh/dockit/blob/main/src/app/api/dock/route.ts"
    click APIDownload "https://github.com/dionnieteh/dockit/blob/main/src/app/api/download/[id]/route.ts"
    click APIAdminUsers "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/users/route.ts"
    click APIAdminUserID "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/users/[id]/route.ts"
    click APIAdminReceptors "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/receptors/route.ts"
    click APIAdminReceptorID "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/receptors/[id]/route.ts"
    click APIAdminParams "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/parameters/route.ts"
    click APIAdminJobs "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/jobs/route.ts"
    click APIAdminJobID "https://github.com/dionnieteh/dockit/blob/main/src/app/api/admin/jobs/[id]/route.ts"

    %% Click Events - Business Logic
    click LibPrisma "https://github.com/dionnieteh/dockit/blob/main/src/lib/prisma.ts"
    click LibSupClient "https://github.com/dionnieteh/dockit/blob/main/src/lib/supabase-client.ts"
    click LibSupServer "https://github.com/dionnieteh/dockit/blob/main/src/lib/supabase-server.ts"
    click LibUsers "https://github.com/dionnieteh/dockit/blob/main/src/lib/users.ts"
    click LibReceptors "https://github.com/dionnieteh/dockit/blob/main/src/lib/receptors.ts"
    click LibJobs "https://github.com/dionnieteh/dockit/blob/main/src/lib/jobs.ts"
    click LibParams "https://github.com/dionnieteh/dockit/blob/main/src/lib/param.ts"
    click LibJobStatus "https://github.com/dionnieteh/dockit/blob/main/src/lib/job-status.ts"
    click LibToast "https://github.com/dionnieteh/dockit/blob/main/src/lib/toast-messages.ts"
    click LibUserContext "https://github.com/dionnieteh/dockit/blob/main/src/lib/user-context.tsx"
    click LibUserRole "https://github.com/dionnieteh/dockit/blob/main/src/lib/user-role.ts"
    click LibUtils "https://github.com/dionnieteh/dockit/blob/main/src/lib/utils.ts"

    %% Styles
    classDef frontend fill:#D0EFFF,stroke:#aaa
    classDef api fill:#D5F5E3,stroke:#aaa
    classDef logic fill:#FCF3CF,stroke:#aaa
    classDef component fill:#FDEDEC,stroke:#aaa
    classDef db fill:#E8DAEF,stroke:#aaa
    classDef worker fill:#E5E8E8,stroke:#aaa
    classDef external fill:#FAD7A0,stroke:#aaa
```
