# studioraketa/raketa-cms architecture

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

- Interactive diagram: https://gitdiagram.com/studioraketa/raketa-cms
- Repository: https://github.com/studioraketa/raketa-cms

## Overview

##### Project type and purpose
- This is a React‐based CMS framework published as the npm package `@raketa-cms/raketa-cms`.
- It provides a **block-based page builder** (“AdminBuilder”) and a **runtime page renderer** (“PageRender”) that can be dropped into any React or Next.js app.
- The repository also includes an **example** Next.js application (`/example`) showing how to integrate the library, and a **starter** Next.js template (`/starters/nextjs`) to speed up adoption.

##### File structure
- **Root**
- `src/` : core CMS code (components, contexts, dialogs, forms, helpers, pickers)
- `example/` : demonstration Next.js app integrating AdminBuilder and PageRender
- `starters/nextjs/` : a full-blown Next.js boilerplate with CMS integration and custom storage glue
- config files: ESLint, Prettier, Travis CI, `.tool-versions` (language manager)
- **Core modules** in `src/` group naturally:
- **Components** (`Canvas.js`, `Container.js`, `List.js`, etc.)
- **Contexts** (`BuilderContext`, `HostContext`, `LibraryContext`)
- **Dialogs** (Reorder, Settings) & **Forms** (text, textarea, select, link, button, custom)
- **Utility libraries** (`helpers/`, `lib/`)
- **Example** shows two “pages”:
- `/admin` renders `AdminBuilder.js` to let editors drag/drop/configure widgets
- `/` renders `PageRender.js` to display the live page

##### README for additional insights
- The CMS is **data-driven**: pages are JSON blobs with a `widgets` array.
- Each widget is defined by a quartet: **Widget** (frontend view), **Config** (metadata), **Defaults**, **Admin** (settings schema).
- Container settings are globally configurable and applied to every widget.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    subgraph "Clients" 
        direction TB
        EditorBrowser["Browser (Editor UI)\n/admin"]:::external
        VisitorBrowser["Browser (Visitor UI)\n/"]:::external
    end

    %% Host Application Layer
    subgraph "Next.js Host (Example)" 
        direction TB
        ExAdminBuilder["AdminBuilder"]:::example
        ExPageRender["PageRender"]:::example
    end

    subgraph "Next.js Host (Starter)" 
        direction TB
        StAdminBuilderWrapper["AdminBuilder Wrapper"]:::starter
        StPageRenderPage["PageRender"]:::starter
    end

    %% CMS Library Modules
    subgraph "CMS Library (@raketa-cms)" 
        direction TB
        subgraph "Admin Modules" 
            direction TB
            AdminBuilder["PageBuilder (AdminBuilder)"]:::core
            CanvasComp["Canvas"]:::core
            LibrarySidebar["Library Sidebar"]:::core
            ReorderDlg["ReorderDialog"]:::core
            SettingsDlg["SettingsDialog"]:::core
            subgraph "Forms"
                direction TB
                TextInput["TextInput"]:::core
                TextArea["TextArea"]:::core
                SelectMenu["SelectMenu"]:::core
                RichText["RichText"]:::core
                ButtonForm["Button"]:::core
                LinkSettings["LinkSettings"]:::core
            end
            BuilderCtx["BuilderContext"]:::core
            LibraryCtx["LibraryContext"]:::core
            HostCtx["HostContext"]:::core
        end
        subgraph "Runtime Modules"
            direction TB
            PageRenderLib["PageRender"]:::core
            ContainerComp["Container"]:::core
            ListComp["List"]:::core
            EmbeddedVideo["EmbeddedVideo"]:::core
            Registry["Widget Registry"]:::core
        end
        subgraph "Utilities"
            direction TB
            Helpers["helpers/"]:::core
            LibUtils["lib/"]:::core
            MediaManager["MediaManager"]:::core
            ImagePicker["ImagePicker"]:::core
        end
    end

    %% Storage / Backend Layer
    subgraph "Storage Adapter" 
        direction TB
        ExStorage["example API / localStorage"]:::external
        StStorage["starters/nextjs/lib/storage.js"]:::external
    end

    %% Example App Routes
    EditorBrowser -->|requests /admin| ExAdminBuilder
    ExAdminBuilder -->|uses| AdminBuilder
    ExAdminBuilder -->|provides| LibraryCtx
    ExAdminBuilder -->|provides| BuilderCtx
    AdminBuilder -->|renders| CanvasComp
    AdminBuilder -->|renders| LibrarySidebar
    CanvasComp -->|uses| ReorderDlg
    CanvasComp -->|uses| SettingsDlg
    AdminBuilder -->|uses forms| TextInput
    AdminBuilder -->|uses forms| TextArea
    AdminBuilder -->|uses forms| SelectMenu
    AdminBuilder -->|uses forms| RichText
    AdminBuilder -->|uses forms| ButtonForm
    AdminBuilder -->|uses forms| LinkSettings
    ExAdminBuilder -->|save JSON| ExStorage

    VisitorBrowser -->|requests /| ExPageRender
    ExPageRender -->|loads JSON| ExStorage
    ExPageRender -->|calls| PageRenderLib
    PageRenderLib -->|renders| ContainerComp
    PageRenderLib -->|renders| ListComp
    PageRenderLib -->|renders| EmbeddedVideo
    PageRenderLib -->|looks up widgets| Registry

    %% Starter App Integration
    EditorBrowser -->|requests /admin| StAdminBuilderWrapper
    StAdminBuilderWrapper -->|wraps| AdminBuilder
    StAdminBuilderWrapper -->|uses storage| StStorage

    VisitorBrowser -->|requests /| StPageRenderPage
    StPageRenderPage -->|wraps| PageRenderLib
    StPageRenderPage -->|uses storage| StStorage

    %% Click Events
    click AdminBuilder "https://github.com/studioraketa/raketa-cms/blob/master/src/PageBuilder.js"
    click CanvasComp "https://github.com/studioraketa/raketa-cms/blob/master/src/Canvas.js"
    click ContainerComp "https://github.com/studioraketa/raketa-cms/blob/master/src/Container.js"
    click ListComp "https://github.com/studioraketa/raketa-cms/blob/master/src/List.js"
    click EmbeddedVideo "https://github.com/studioraketa/raketa-cms/blob/master/src/EmbeddedVideo.js"
    click BuilderCtx "https://github.com/studioraketa/raketa-cms/blob/master/src/contexts/BuilderContext.js"
    click LibraryCtx "https://github.com/studioraketa/raketa-cms/blob/master/src/LibraryContext.js"
    click HostCtx "https://github.com/studioraketa/raketa-cms/blob/master/src/HostContext.js"
    click ReorderDlg "https://github.com/studioraketa/raketa-cms/blob/master/src/dialogs/ReorderDialog.js"
    click SettingsDlg "https://github.com/studioraketa/raketa-cms/blob/master/src/dialogs/SettingsDialog.js"
    click TextInput "https://github.com/studioraketa/raketa-cms/blob/master/src/forms/TextInput.js"
    click TextArea "https://github.com/studioraketa/raketa-cms/blob/master/src/forms/TextArea.js"
    click SelectMenu "https://github.com/studioraketa/raketa-cms/blob/master/src/forms/SelectMenu.js"
    click RichText "https://github.com/studioraketa/raketa-cms/blob/master/src/forms/RichText.js"
    click ButtonForm "https://github.com/studioraketa/raketa-cms/blob/master/src/forms/Button.js"
    click LinkSettings "https://github.com/studioraketa/raketa-cms/blob/master/src/forms/LinkSettings.js"
    click Helpers "https://github.com/studioraketa/raketa-cms/tree/master/src/helpers/"
    click LibUtils "https://github.com/studioraketa/raketa-cms/tree/master/src/lib/"
    click MediaManager "https://github.com/studioraketa/raketa-cms/blob/master/src/MediaManager.js"
    click ImagePicker "https://github.com/studioraketa/raketa-cms/blob/master/src/pickers/ImagePicker/ImagePicker.js"
    click ExAdminBuilder "https://github.com/studioraketa/raketa-cms/blob/master/example/src/AdminBuilder.js"
    click ExPageRender "https://github.com/studioraketa/raketa-cms/blob/master/example/src/PageRender.js"
    click StPageRenderPage "https://github.com/studioraketa/raketa-cms/blob/master/starters/nextjs/components/PageRender.js"
    click StAdminBuilderWrapper "https://github.com/studioraketa/raketa-cms/blob/master/starters/nextjs/components/AdminBuilder.js"
    click StStorage "https://github.com/studioraketa/raketa-cms/blob/master/starters/nextjs/lib/storage.js"

    %% Styles
    classDef core fill:#CFE2F3,stroke:#0B5394,color:#0B5394
    classDef example fill:#D9EAD3,stroke:#38761D,color:#38761D
    classDef starter fill:#EAD1DC,stroke:#741B47,color:#741B47
    classDef external fill:#FCE5CD,stroke:#E69138,color:#E69138
```
