# connorrmcneil/software-engineering-2025-project architecture

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

- Interactive diagram: https://gitdiagram.com/connorrmcneil/software-engineering-2025-project
- Repository: https://github.com/connorrmcneil/software-engineering-2025-project

## Overview

##### Project type and purpose
- This is a full-stack, monorepo web application for a language-learning game and dictionary.
- The `packages/front-end` folder contains a React + Vite + TypeScript SPA with matching-game and dictionary pages.
- The `packages/api` folder holds a Node/Bun + TypeScript backend using Prisma ORM and SQLite (`app.db`) to serve REST endpoints for authentication, user data, and word data.

##### File structure
- Top level:
- Configuration (`.gitignore`, `package.json`, `tailwind.config.js`, etc.)
- `packages/api`: backend service
- `packages/front-end`: frontend application
- `packages/api/src`: organized by controllers (`auth.ts`, `users.ts`, `words.ts`), middleware, and entrypoint (`main.ts`).
- `packages/api/prisma`: schema, database file, and seed script.
- `packages/front-end/src`:
- `pages`: React page components (`matching-game.tsx`, `dictionary.tsx`, etc.)
- `components`: reusable UI pieces (audio buttons, modals, cards)
- `router`: loader functions and route configuration
- `assets`: static audio and image files for the game
- `api.ts`: frontend HTTP wrapper for calling the backend

##### README for additional insights
- The README covers naming conventions, not architecture – it confirms use of TypeScript, React, and file naming patterns.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend (React SPA)"
        direction TB
        Browser["User's Browser"]:::external
        EntryPoint["main.tsx"]:::frontend
        HTMLTemplate["index.html"]:::frontend
        Router["router.tsx"]:::frontend
        APIClient["api.ts"]:::frontend
        subgraph "Pages"
            direction TB
            Home["home-page.tsx"]:::frontend
            MatchingGame["matching-game.tsx"]:::frontend
            Dictionary["dictionary.tsx"]:::frontend
            SignIn["signin.tsx"]:::frontend
            AdminPage["admin.tsx"]:::frontend
            Error404["404error.tsx"]:::frontend
        end
        subgraph "Route Loaders"
            direction TB
            AdminLoader["admin.loader.ts"]:::frontend
            AuthLoader["auth.loader.ts"]:::frontend
            SignInLoader["signin.loader.ts"]:::frontend
            WordsLoader["words.loader.ts"]:::frontend
        end
        subgraph "UI Components"
            direction TB
            Components["components/*.tsx"]:::frontend
        end
        subgraph "Static Assets (FE)" 
            direction TB
            Audio["audio/matching-game-audio/"]:::asset
            Images["images/"]:::asset
        end
    end

    %% Backend Layer
    subgraph "Backend (Node/Bun Service)"
        direction TB
        BackendServer["main.ts"]:::backend
        Middleware["auth.middleware.ts"]:::backend
        subgraph "Controllers"
            direction TB
            AuthCtrl["auth.ts"]:::backend
            UsersCtrl["users.ts"]:::backend
            WordsCtrl["words.ts"]:::backend
        end
        PrismaInit["prisma.ts"]:::backend
        subgraph "Prisma & Database"
            direction TB
            Schema["schema.prisma"]:::db
            Seed["seed.ts"]:::db
            Database["app.db"]:::db
        end
        PublicAssets["public/ (MP3s)"]:::asset
    end

    %% Connections
    Browser -->|"loads"| HTMLTemplate
    HTMLTemplate -->|"bootstraps"| EntryPoint
    EntryPoint -->|"imports"| Router
    Router -->|"renders"| Home
    Router -->|"renders"| MatchingGame
    Router -->|"renders"| Dictionary
    Router -->|"renders"| SignIn
    Router -->|"renders"| AdminPage
    Router -->|"renders"| Error404
    MatchingGame -->|"uses"| Components
    Dictionary -->|"uses"| Components
    Home -->|"uses loaders"| AdminLoader
    SignIn -->|"uses loaders"| SignInLoader
    AdminPage -->|"uses loaders"| AdminLoader
    Dictionary -->|"uses loaders"| WordsLoader
    MatchingGame -->|"uses loaders"| WordsLoader
    PagesClicks[Hidden] -->|"calls"| APIClient
    APIClient -->|"HTTP /auth, /users, /words"| BackendServer
    BackendServer -->|"checks JWT"| Middleware
    Middleware -->|"routes"| AuthCtrl
    Middleware -->|"routes"| UsersCtrl
    Middleware -->|"routes"| WordsCtrl
    AuthCtrl -->|"uses"| PrismaInit
    UsersCtrl -->|"uses"| PrismaInit
    WordsCtrl -->|"uses"| PrismaInit
    PrismaInit -->|"executes queries"| Schema
    Schema --> Database
    Seed --> Database
    Browser -->|"fetch static assets"| Audio
    Browser -->|"fetch static assets"| Images
    Browser -->|"fetch static assets"| PublicAssets

    %% Click Events Frontend
    click EntryPoint "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/main.tsx"
    click HTMLTemplate "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/index.html"
    click Router "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/router/router.tsx"
    click AdminLoader "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/router/admin.loader.ts"
    click AuthLoader "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/router/auth.loader.ts"
    click SignInLoader "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/router/signin.loader.ts"
    click WordsLoader "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/router/words.loader.ts"
    click APIClient "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/api.ts"
    click Home "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/pages/home-page.tsx"
    click MatchingGame "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/pages/matching-game.tsx"
    click Dictionary "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/pages/dictionary.tsx"
    click SignIn "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/pages/signin.tsx"
    click AdminPage "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/pages/admin.tsx"
    click Error404 "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/front-end/src/pages/404error.tsx"
    click Components "https://github.com/connorrmcneil/software-engineering-2025-project/tree/main/packages/front-end/src/components/"
    click Audio "https://github.com/connorrmcneil/software-engineering-2025-project/tree/main/packages/front-end/src/assets/audio/matching-game-audio/"
    click Images "https://github.com/connorrmcneil/software-engineering-2025-project/tree/main/packages/front-end/src/assets/images/"

    %% Click Events Backend
    click BackendServer "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/src/main.ts"
    click Middleware "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/src/middleware/auth.middleware.ts"
    click AuthCtrl "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/src/controllers/auth.ts"
    click UsersCtrl "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/src/controllers/users.ts"
    click WordsCtrl "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/src/controllers/words.ts"
    click PrismaInit "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/src/prisma.ts"
    click Schema "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/prisma/schema.prisma"
    click Seed "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/prisma/seed.ts"
    click Database "https://github.com/connorrmcneil/software-engineering-2025-project/blob/main/packages/api/prisma/app.db"
    click PublicAssets "https://github.com/connorrmcneil/software-engineering-2025-project/tree/main/packages/api/public/"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#000,stroke-width:1px
    classDef backend fill:#d4edda,stroke:#000,stroke-width:1px
    classDef db fill:#fff3cd,stroke:#000,stroke-width:1px
    classDef asset fill:#e2e3e5,stroke:#000,stroke-width:1px
    classDef external fill:#f8d7da,stroke:#000,stroke-width:1px
```
