# ginoking/memories architecture

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

- Interactive diagram: https://gitdiagram.com/ginoking/memories
- Repository: https://github.com/ginoking/memories

## Overview

##### Main Components

A. Client-Side (Frontend):
- Vue 3 + TypeScript application
- Key components:
- Authentication views (Login, Signup, Reset)
- Main application views (HomeView, Info)
- Shared components (EventModal, TypeSelector, etc.)
- Axios for API communication

B. Server-Side (Backend):
- Node.js Express application
- Authentication system
- Controllers layer
- Validation layer
- Database interface layer

C. Database:
- MongoDB with Mongoose ODM

D. Infrastructure:
- Docker containers
- GCP Services (Cloud Build, Artifact Registry, Cloud Run)

**[Client Layer]**
- ↕️
**[Server Layer]**
- ↕️
**[Database Layer]**

**[GCP Cloud Run]**
- ↓
**[Docker Containers]**
- ↓
**[Application Layers]**

##### Specific Component Details

A. Client Container:
- Main Vue components and stores
- Axios communication layer

B. Server Container:
- Express.js application structure
- Authentication flow (passport-local-mongoose, JWT)
- Controller organization
- Validation layer

C. Database Container:
- MongoDB connection
- Main collections (users, stories)

D. Infrastructure Layer:
- GCP Cloud Build pipeline
- Artifact Registry connection
- Demonstrate Cloud Run deployment

##### Important Flows to Highlight

A. Authentication Flow:
**Client Login → JWT Generation → Token Storage → Protected Routes**

B. Data Flow:
**Client Request → Validation → Controller → Database → Response**

C. Deployment Flow:
**GitHub Push → Cloud Build → Artifact Registry → Cloud Run**

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Infrastructure
        GCB[Google Cloud Build]
        GAR[Google Artifact Registry]
        GCR[Google Cloud Run]
        DC["Docker Compose"]:::infra
        DN["Nginx Config"]:::infra
        
        GCB --> GAR
        GAR --> GCR
        DC --> GCB
    end

    subgraph "Client Layer"
        direction TB
        VueApp["Vue.js Application"]:::frontend
        
        subgraph "Views"
            direction TB
            Login["Login View"]:::frontend
            Signup["Signup View"]:::frontend
            Reset["Password Reset"]:::frontend
            Home["Home View"]:::frontend
            Info["Info View"]:::frontend
        end
        
        subgraph "Components"
            direction TB
            EM["Event Modal"]:::frontend
            TS["Type Selector"]:::frontend
            Days["Days Component"]:::frontend
        end
        
        AC["Axios Client"]:::frontend
        
        VueApp --> Views
        VueApp --> Components
        VueApp --> AC
    end
    
    subgraph "Server Layer"
        direction TB
        Express["Express.js Server"]:::backend
        
        subgraph "Authentication"
            direction TB
            Auth["Auth Service"]:::auth
            AuthC["Auth Controller"]:::auth
            PassC["Passkey Controller"]:::auth
        end
        
        subgraph "Controllers"
            direction TB
            EventC["Event Controller"]:::backend
            CreateC["Create Controller"]:::backend
        end
        
        subgraph "Validation"
            direction TB
            LoginV["Login Validator"]:::validator
            CreateV["Create Validator"]:::validator
            EventV["Event Validator"]:::validator
            PassV["Password Validator"]:::validator
        end
    end
    
    subgraph "Database Layer"
        MongoDB[(MongoDB)]:::database
        Users[("Users Collection")]:::database
        Stories[("Stories Collection")]:::database
        
        MongoDB --> Users
        MongoDB --> Stories
    end
    
    AC --> Express
    Express --> Auth
    Auth --> MongoDB
    Express --> Controllers
    Controllers --> Validation
    Controllers --> MongoDB

    %% Click Events
    click Login "https://github.com/ginoking/memories/blob/main/client/src/views/Login.vue"
    click Signup "https://github.com/ginoking/memories/blob/main/client/src/views/Signup.vue"
    click Reset "https://github.com/ginoking/memories/blob/main/client/src/views/Reset.vue"
    click Home "https://github.com/ginoking/memories/blob/main/client/src/views/HomeView.vue"
    click Info "https://github.com/ginoking/memories/blob/main/client/src/views/Info.vue"
    click EM "https://github.com/ginoking/memories/blob/main/client/src/components/EventModal.vue"
    click TS "https://github.com/ginoking/memories/blob/main/client/src/components/TypeSelector.vue"
    click Days "https://github.com/ginoking/memories/blob/main/client/src/components/Days.vue"
    click AC "https://github.com/ginoking/memories/blob/main/client/src/axios/axios.ts"
    click Auth "https://github.com/ginoking/memories/blob/main/server/auth/auth.js"
    click AuthC "https://github.com/ginoking/memories/blob/main/server/controllers/authController.js"
    click PassC "https://github.com/ginoking/memories/blob/main/server/controllers/passkeyController.js"
    click EventC "https://github.com/ginoking/memories/blob/main/server/controllers/eventController.js"
    click CreateC "https://github.com/ginoking/memories/blob/main/server/controllers/createController.js"
    click LoginV "https://github.com/ginoking/memories/blob/main/server/validations/loginValidate.js"
    click CreateV "https://github.com/ginoking/memories/blob/main/server/validations/createValidate.js"
    click EventV "https://github.com/ginoking/memories/blob/main/server/validations/eventValidate.js"
    click PassV "https://github.com/ginoking/memories/blob/main/server/validations/passwordValidate.js"
    click MongoDB "https://github.com/ginoking/memories/blob/main/server/database/mongodb.js"
    click Users "https://github.com/ginoking/memories/blob/main/server/database/users.js"
    click Stories "https://github.com/ginoking/memories/blob/main/server/database/stories.js"
    click DC "https://github.com/ginoking/memories/blob/main/docker-compose.yml"
    click DN "https://github.com/ginoking/memories/blob/main/client/nginx/default.conf"

    %% Styling
    classDef frontend fill:#2196F3,color:white
    classDef backend fill:#4CAF50,color:white
    classDef database fill:#FFC107,color:black
    classDef auth fill:#9C27B0,color:white
    classDef validator fill:#FF5722,color:white
    classDef infra fill:#607D8B,color:white

    %% Legend
    subgraph Legend
        F[Frontend]:::frontend
        B[Backend]:::backend
        D[(Database)]:::database
        A[Auth]:::auth
        V[Validation]:::validator
        I[Infrastructure]:::infra
    end
```
