# interaapps/pastefy architecture

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

- Interactive diagram: https://gitdiagram.com/interaapps/pastefy
- Repository: https://github.com/interaapps/pastefy

## Overview

##### Project Type and Purpose
- This is a full-stack web application called **Pastefy**, an open-source alternative to Gist/Pastebin.
- Purpose: Allow users to create, view, share and manage code snippets (“pastes”) via a Vue.js single-page frontend and a Java-based REST backend.

##### File Structure
- Top-level folders:
- **frontend/** – Vue 3 SPA, built with Vite, Tailwind, Pinia, Vue Router
- **backend/** – Maven-based Java project (likely Javalin or similar lightweight HTTP framework)
- **deployment/** & docker-compose.yml – Kubernetes, Docker Compose, CI/CD manifests
- Key backend subfolders:
- **controller/** – REST endpoints (pastes, users, public area, admin, auth)
- **auth/** – Middleware and OAuth2 strategies (Discord, GitHub, Google, InteraApps, Twitch)
- **model/database/** – JPA-like entities (Paste, User, Folder, Notification, etc.)
- **model/plugins/** – Plugin abstraction interfaces for extending backend
- **ai/** – AI integration feature (PasteAI)
- Key frontend subfolders:
- **components/**, **views/**, **router/**, **stores/** – Typical Vue-based structure
- Deployment files: Dockerfile, docker-compose.yml, Kubernetes prod.yaml

##### Extract Insights from the README
- Describes features (raw preview, fork, API v2, OAuth login, folders, admin panel)
- Deployment options: Docker, Docker Compose, Kubernetes, container-less
- Configuration via environment variables
- Development workflows: separate frontend dev server and backend on port 1337

##### Detail Without Overthinking
- Every meaningful component: SPA, HTTP server, Controllers, Middleware, Plugins, AI, DB, OAuth providers
- How data flows end-to-end when a user creates or views a paste

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Docker/Kubernetes Pod"
        style Pod fill:#f9f9f9,stroke:#333,stroke-width:2px
        subgraph "Frontend Tier"
            direction TB
            FrontendSPA["Vue.js SPA"]:::frontend
            MainTs["Entry Point: main.ts"]:::frontend
            Router["Router: index.ts"]:::frontend
            Stores["Stores: /stores"]:::frontend
            Components["Components: /components"]:::frontend
            Views["Views: /views"]:::frontend
            Public["Public Assets"]:::frontend
            FrontendSPA -->|built with Vite| MainTs
            MainTs --> Router
            MainTs --> Stores
            MainTs --> Components
            MainTs --> Views
            FrontendSPA --> Public
        end

        subgraph "Backend Tier"
            direction TB
            Bootstrap["Bootstrap: Pastefy.java"]:::backend
            subgraph Controllers
                direction TB
                AppCtrl["AppController.java"]:::backend
                PasteCtrl["PasteController.java"]:::backend
                UserCtrl["UserController.java"]:::backend
                FolderCtrl["FolderController.java"]:::backend
                PublicAreaCtrl["PublicPastesController.java"]:::backend
                AdminCtrl["AdminController.java"]:::backend
                StatsCtrl["StatsController.java"]:::backend
                AuthCtrl["InteraAppsExternalAccessController.java"]:::backend
                Bootstrap --> AppCtrl
                Bootstrap --> PasteCtrl
                Bootstrap --> UserCtrl
                Bootstrap --> FolderCtrl
                Bootstrap --> PublicAreaCtrl
                Bootstrap --> AdminCtrl
                Bootstrap --> StatsCtrl
                Bootstrap --> AuthCtrl
            end
            AuthMiddleware["Auth Middleware"]:::backend
            OAuth2["OAuth2 Strategies & Providers"]:::backend
            PluginEngine["Plugin Engine Interfaces"]:::backend
            AIModule["AI Module: PasteAI"]:::backend
            Models["Database Models"]:::backend
            DTOs["DTOs"]:::backend
            Exceptions["Exceptions"]:::backend
            Helpers["Helper Utilities"]:::backend

            AppCtrl --> AuthMiddleware
            UserCtrl --> AuthMiddleware
            AuthMiddleware --> OAuth2
            Bootstrap --> PluginEngine
            Bootstrap --> AIModule
            Bootstrap --> Models
            Controllers --> Models
            Controllers --> DTOs
            Controllers --> Exceptions
            Controllers --> Helpers
            AIModule --> ExternalAI["External AI Service"]:::external
        end

        Browser["Web Browser"]:::external
        Browser -->|HTTPS/REST| FrontendSPA
        FrontendSPA -->|HTTPS/REST| Bootstrap
        Bootstrap -->|JDBC/MySQL| Database["MySQL Database"]:::external
        OAuth2 -->|OAuth2 Token Exchange| OAuthProviders["GitHub, Google, Discord, Twitch, InteraApps"]:::external
    end

    classDef frontend fill:#bbdefb,stroke:#1e88e5,color:#0d47a1;
    classDef backend fill:#c8e6c9,stroke:#2e7d32,color:#1b5e20;
    classDef external fill:#ffe0b2,stroke:#ef6c00,color:#e65100;

    click FrontendSPA "https://github.com/interaapps/pastefy/tree/master/frontend/"
    click MainTs "https://github.com/interaapps/pastefy/blob/master/frontend/src/main.ts"
    click Router "https://github.com/interaapps/pastefy/blob/master/frontend/src/router/index.ts"
    click Stores "https://github.com/interaapps/pastefy/tree/master/frontend/src/stores/"
    click Components "https://github.com/interaapps/pastefy/tree/master/frontend/src/components/"
    click Views "https://github.com/interaapps/pastefy/tree/master/frontend/src/views/"
    click Public "https://github.com/interaapps/pastefy/tree/master/frontend/public/"
    click Bootstrap "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/Pastefy.java"
    click AppCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/AppController.java"
    click PasteCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/pastes/PasteController.java"
    click UserCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/user/UserController.java"
    click FolderCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/FolderController.java"
    click PublicAreaCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/publicarea/PublicPastesController.java"
    click AdminCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/admin/AdminController.java"
    click StatsCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/stats/StatsController.java"
    click AuthCtrl "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/controller/auth/InteraAppsExternalAccessController.java"
    click AuthMiddleware "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/auth/AuthMiddleware.java"
    click OAuth2 "https://github.com/interaapps/pastefy/tree/master/backend/src/main/java/de/interaapps/pastefy/auth/strategies/oauth2/"
    click PluginEngine "https://github.com/interaapps/pastefy/tree/master/backend/src/main/java/de/interaapps/pastefy/model/plugins/"
    click AIModule "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/ai/PasteAI.java"
    click Models "https://github.com/interaapps/pastefy/tree/master/backend/src/main/java/de/interaapps/pastefy/model/database/"
    click DTOs "https://github.com/interaapps/pastefy/tree/master/backend/src/main/java/de/interaapps/pastefy/model/requests/"
    click Exceptions "https://github.com/interaapps/pastefy/tree/master/backend/src/main/java/de/interaapps/pastefy/exceptions/"
    click Helpers "https://github.com/interaapps/pastefy/blob/master/backend/src/main/java/de/interaapps/pastefy/helper/RequestHelper.java"
    click Dockerfile "https://github.com/interaapps/pastefy/tree/master/Dockerfile"
    click DockerCompose "https://github.com/interaapps/pastefy/blob/master/docker-compose.yml"
    click K8sManifest "https://github.com/interaapps/pastefy/blob/master/deployment/prod.yaml"
```
