# canvasbird/canvasboard-backend architecture

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

- Interactive diagram: https://gitdiagram.com/canvasbird/canvasboard-backend
- Repository: https://github.com/canvasbird/canvasboard-backend

## Overview

##### Project Type and Purpose
- This is the backend for Canvasboard, a Node.js/Express API service that supports an interactive teaching/presentation platform.
- It exposes REST endpoints for user auth, board management, file and folder operations, sharing, and Google OAuth.

##### File Structure Overview
- APIs/
- app.js – Express app entry point
- Routes/ – API route definitions
- controllers/ – Business logic split by feature (auth, file, folder, board, share, upload)
- models/ – MongoDB schemas and connection setup
- middlewares/ – JWT/permission checks
- config/ – DB config, MinIO (object storage) config
- passportSetup.js – Google OAuth strategy
- docker-compose.yaml, local/docker-compose.yaml – Service definitions (API, MongoDB, MinIO)
- ansible/ – Playbook for provisioning servers
- .github/ – CI/CD workflows and custom Ansible action

##### Key Components
- Clients: Browser or Front‑end app
- API Layer:
- NGINX (optional reverse proxy)
- Express server (app.js)
- Middleware: Authentication, error handlers
- Controllers: authCtrl, boardCtrl, file/*, folder/*, shareCtrl, uploadCtrl
- Data Layer:
- MongoDB (collections: users, boards, files, folders, sharedFiles, passwordResets)
- MinIO object storage for file blobs
- External Services: Google OAuth endpoint
- Deployment/Infra: Docker containers, Ansible provisioning

##### Relationships and Interactions
- Client → NGINX → Express routes
- Routes → Middleware → Controllers
- Controllers → Models → MongoDB
- File upload/download → Controllers → MinIO
- Auth requests → Controllers → Google OAuth / MongoDB
- CI/CD pipeline triggers Ansible playbook

##### Architectural Patterns and Technologies
- MVC‑inspired separation: routes → controllers → models
- Token‑based auth with JWT middleware
- External OAuth integration (Passport + Google)
- Containerized deployment (Docker Compose + Ansible)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    subgraph "Clients"
        Client["Browser / Front-end"]:::external
    end

    %% API Layer
    subgraph "API Layer"
        NGINX["NGINX"]:::compute
        Express["Express Server"]:::compute
    end
    Client -->|HTTP/HTTPS| NGINX
    NGINX -->|HTTP/HTTPS| Express
    click Express "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/app.js"

    %% Express Application
    subgraph "Express Application"
        subgraph "Routes"
            IndexRoutes["Index Routes"]:::compute
            FileRoutes["File Routes"]:::compute
            FolderRoutes["Folder Routes"]:::compute
            AuthRoutes["Auth & Google Routes"]:::compute
        end
        subgraph "Middlewares"
            JWT["JWT Middleware"]:::compute
            ErrorHandler["Error Handler"]:::compute
        end
        subgraph "Controllers"
            AuthCtrl["Auth Controller"]:::compute
            GoogleAuth["Google OAuth Controller"]:::compute
            BoardCtrl["Board Controller"]:::compute
            FileCtrl["File Controllers"]:::compute
            FolderCtrl["Folder Controllers"]:::compute
            ShareCtrl["Share Controller"]:::compute
            UploadCtrl["Upload Controller"]:::compute
        end
    end

    Express -->|uses REST| IndexRoutes
    click IndexRoutes "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/Routes/index.js"
    IndexRoutes -->|file ops| FileRoutes
    click FileRoutes "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/Routes/file.js"
    IndexRoutes -->|folder ops| FolderRoutes
    click FolderRoutes "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/Routes/folder.js"
    IndexRoutes -->|auth| AuthRoutes

    FileRoutes -->|JWT verify| JWT
    FolderRoutes -->|JWT verify| JWT
    AuthRoutes -->|JWT verify| JWT
    click JWT "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/middlewares/auth.js"
    AuthRoutes -->|OAuth flow| GoogleAuth
    click GoogleAuth "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/controllers/googleAuth.js"

    JWT --> AuthCtrl
    click AuthCtrl "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/controllers/authCtrl.js"
    FileRoutes --> FileCtrl
    click FileCtrl "https://github.com/canvasbird/canvasboard-backend/tree/master/APIs/controllers/file/"
    FolderRoutes --> FolderCtrl
    click FolderCtrl "https://github.com/canvasbird/canvasboard-backend/tree/master/APIs/controllers/folder/"
    AuthRoutes --> BoardCtrl
    click BoardCtrl "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/controllers/boardCtrl.js"
    FileCtrl --> UploadCtrl
    click UploadCtrl "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/controllers/uploadCtrl.js"
    FileCtrl --> ShareCtrl
    click ShareCtrl "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/controllers/shareCtrl.js"

    %% Data Layer
    subgraph "Data Layer"
        MongoDB["MongoDB"]:::datastore
        MinIO["MinIO Object Storage"]:::storage
    end

    AuthCtrl -->|read/write| MongoDB
    BoardCtrl -->|read/write| MongoDB
    FileCtrl -->|metadata| MongoDB
    FolderCtrl -->|metadata| MongoDB
    ShareCtrl -->|metadata| MongoDB
    FileCtrl -->|blobs| MinIO
    UploadCtrl -->|blobs| MinIO

    click MongoDB "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/models/db.js"
    click MinIO "https://github.com/canvasbird/canvasboard-backend/blob/master/APIs/config/minio.js"

    %% External Services
    subgraph "External Services"
        ExternalGoogle["Google OAuth"]:::external
    end
    GoogleAuth -->|OAuth API| ExternalGoogle

    %% Deployment
    subgraph "Deployment & CI/CD"
        DockerCompose["Docker Compose"]:::compute
        Ansible["Ansible Playbook"]:::compute
        CI_CD["CI/CD Workflow"]:::compute
    end
    DockerCompose --> Express
    DockerCompose --> MongoDB
    DockerCompose --> MinIO
    click DockerCompose "https://github.com/canvasbird/canvasboard-backend/blob/master/docker-compose.yaml"
    CI_CD -->|deploy| Ansible
    click Ansible "https://github.com/canvasbird/canvasboard-backend/blob/master/ansible/playbook.yml"
    click CI_CD "https://github.com/canvasbird/canvasboard-backend/blob/master/.github/workflows/main.yml"

    %% Styles
    classDef compute fill:#D0E8FF,stroke:#333,stroke-width:1px
    classDef datastore fill:#D4F1BE,stroke:#333,stroke-width:1px
    classDef storage fill:#FFD8A9,stroke:#333,stroke-width:1px
    classDef external fill:#E8E8E8,stroke:#333,stroke-width:1px
```
