# vlyon07/beers4all architecture

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

- Interactive diagram: https://gitdiagram.com/vlyon07/beers4all
- Repository: https://github.com/vlyon07/beers4all

## Overview

##### Project type and purpose
- BeerAll is a full-stack web application for browsing, reviewing, and favoriting breweries worldwide.
- Frontend: Vue 3 + Vite + Tailwind (PWA).
- Backend: Node.js + Express + Sequelize (PostgreSQL).
- Persistence: Supabase-hosted Postgres.
- Deploy: Render (frontend & API), Supabase (DB).
- Integrates with the OpenBreweryDB external API for initial brewery data.

##### File structure
Top-level:
- backend/
– backend.js (Express app entry)
– config/ (DB & JWT secrets)
– controllers/ (authController, userController)
– middleware/ (authMiddleware)
– models/ (User, Review, Favorite + index)
– routes/ (auth.js, user.js)
– db.js (Sequelize init)
– migrations/, seeders/ (DB versioning & demo data)
- frontend/
– src/
- main.js, App.vue
- components/ (BreweryCard, Navbar, useUser composable)
- router/ (Vue Router)
- views/ (Landing, Login, etc.)
- assets/ (CSS, images)
– Vite/Tailwind/Vuetify configs
– .env.* for dev/prod endpoints & keys

##### README for architectural insights
- Confirms separation of concerns: Vue SPA calls Express REST API.
- Auth uses JWT_SECRET, protected routes via authMiddleware.
- DB migrations/seeders maintain schema.
- External dependencies: OpenBreweryDB, Supabase, Render.

a. Main components:
1. Client Browser (Vue SPA)
2. Static Asset Host (Render CDN)
3. Backend Service (Node/Express API on Render)
4. Database (PostgreSQL on Supabase)
5. External API (openbrewerydb.org)
b. Relationships & interactions:
- Browser ⇄ Static Host: serves index.html, JS, CSS.
- Browser → Backend API: REST calls (auth, users, reviews, favorites).
- Backend → Database: Sequelize ORM queries.
- Backend → External API: initial brewery data fetch (at dev or build time).
c. Architectural patterns:
- MVC-style layering in backend (routes → controllers → models).
- JWT-based auth middleware.
- Vue component architecture with composables (useUser), router.
d. Key technologies:
- Node.js, Express, Sequelize, PostgreSQL
- Vue 3, Vite, Tailwind CSS, Vuetify, Vue Router
- JWT, dotenv for config
- Render (hosting), Supabase (DB), OpenBreweryDB (3rd-party data)

##### Detail to capture
- Middleware intercepting requests before controllers.
- Migrations/seeders as part of the deployment workflow.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend (Vue SPA)"
        direction TB
        MainJS["main.js"]:::code
        Components["Components"]:::code
        BreweryCard["BreweryCard.vue"]:::code
        Navbar["Navbar.vue"]:::code
        Router["router/index.js"]:::code
        Views["Views"]:::code
        Landing["Landing.vue"]:::code
        Login["Login.vue"]:::code
        Assets["Assets"]:::code
        PublicAssets["public"]:::code
        BaseCSS["base.css"]:::code
        MainCSS["main.css"]:::code
        Configs["Config"]:::config
        ViteConfig["vite.config.js"]:::config
        TailwindConfig["tailwind.config.js"]:::config
        EnvDev[".env.development"]:::config
        EnvProd[".env.production"]:::config

        MainJS -->|uses| Components
        Components --> BreweryCard
        Components --> Navbar
        MainJS -->|uses| Router
        Router --> Views
        Views --> Landing
        Views --> Login
        MainJS -->|loads| Assets
        Assets --> PublicAssets
        Assets --> BaseCSS
        Assets --> MainCSS
        MainJS -->|configured by| Configs
        Configs --> ViteConfig
        Configs --> TailwindConfig
        Configs --> EnvDev
        Configs --> EnvProd
    end

    %% Backend Layer
    subgraph "Backend (Node.js/Express API)"
        direction TB
        BackendJS["backend.js"]:::code
        Config["config/config.js"]:::config
        DBInit["db.js"]:::code
        Models["Models"]:::code
        UserModel["User.js"]:::code
        ReviewModel["Review.js"]:::code
        FavoriteModel["Favorite.js"]:::code
        ModelIndex["index.js"]:::code
        Controllers["Controllers"]:::code
        AuthController["authController.js"]:::code
        UserController["userController.js"]:::code
        Routes["Routes"]:::code
        AuthRoutes["auth.js"]:::code
        UserRoutes["user.js"]:::code
        Middleware["authMiddleware.js"]:::code
        Migrations["migrations"]:::database
        Seeders["seeders"]:::database

        BackendJS -->|imports| Config
        BackendJS -->|initializes| DBInit
        DBInit -->|defines| Models
        Models --> UserModel
        Models --> ReviewModel
        Models --> FavoriteModel
        Models --> ModelIndex
        BackendJS -->|uses| Routes
        Routes --> AuthRoutes
        Routes --> UserRoutes
        AuthRoutes -->|calls| AuthController
        UserRoutes -->|calls| UserController
        Routes --> Middleware
        Controllers -->|use| Models
        BackendJS -->|runs| Migrations
        BackendJS -->|runs| Seeders
    end

    %% Infrastructure & Deployments
    subgraph "Infrastructure & CI/CD"
        direction TB
        CICD["CI/CD Pipeline"]:::infra
        RenderCDN["Render CDN"]:::infra
        RenderAPI["Render API"]:::infra
        SupabaseDB["Supabase DB"]:::infra
    end

    %% Core Runtime
    Browser["Browser"]:::client
    API["API Server"]:::server
    CDN["Static Host"]:::infra
    DB["PostgreSQL"]:::database
    External["OpenBreweryDB API"]:::external

    %% Relationships
    Browser -->|HTTP GET index.html, JS, CSS| CDN
    Browser -->|HTTP REST| API
    API -->|SQL queries| DB
    API -->|HTTP requests| External
    CICD -->|deploys frontend| CDN
    CICD -->|deploys backend| API
    CICD -->|runs migrations & seeders| DB
    API -->|hosted on| RenderAPI
    CDN -->|served via| RenderCDN
    DB -->|hosted on| SupabaseDB

    %% Click Events
    click BreweryCard "https://github.com/vlyon07/beers4all/blob/main/frontend/src/components/BreweryCard.vue"
    click Navbar "https://github.com/vlyon07/beers4all/blob/main/frontend/src/components/Navbar.vue"
    click MainJS "https://github.com/vlyon07/beers4all/blob/main/frontend/src/main.js"
    click Landing "https://github.com/vlyon07/beers4all/blob/main/frontend/src/views/Landing.vue"
    click Login "https://github.com/vlyon07/beers4all/blob/main/frontend/src/views/Login.vue"
    click Router "https://github.com/vlyon07/beers4all/blob/main/frontend/src/router/index.js"
    click PublicAssets "https://github.com/vlyon07/beers4all/tree/main/frontend/public"
    click BaseCSS "https://github.com/vlyon07/beers4all/blob/main/frontend/src/assets/base.css"
    click MainCSS "https://github.com/vlyon07/beers4all/blob/main/frontend/src/assets/main.css"
    click ViteConfig "https://github.com/vlyon07/beers4all/blob/main/frontend/vite.config.js"
    click TailwindConfig "https://github.com/vlyon07/beers4all/blob/main/frontend/tailwind.config.js"
    click EnvDev "https://github.com/vlyon07/beers4all/blob/main/frontend/.env.development"
    click EnvProd "https://github.com/vlyon07/beers4all/blob/main/frontend/.env.production"
    click BackendJS "https://github.com/vlyon07/beers4all/blob/main/backend/backend.js"
    click Config "https://github.com/vlyon07/beers4all/blob/main/backend/config/config.js"
    click DBInit "https://github.com/vlyon07/beers4all/blob/main/backend/db.js"
    click UserModel "https://github.com/vlyon07/beers4all/blob/main/backend/models/User.js"
    click ReviewModel "https://github.com/vlyon07/beers4all/blob/main/backend/models/Review.js"
    click FavoriteModel "https://github.com/vlyon07/beers4all/blob/main/backend/models/Favorite.js"
    click ModelIndex "https://github.com/vlyon07/beers4all/blob/main/backend/models/index.js"
    click AuthController "https://github.com/vlyon07/beers4all/blob/main/backend/controllers/authController.js"
    click UserController "https://github.com/vlyon07/beers4all/blob/main/backend/controllers/userController.js"
    click AuthRoutes "https://github.com/vlyon07/beers4all/blob/main/backend/routes/auth.js"
    click UserRoutes "https://github.com/vlyon07/beers4all/blob/main/backend/routes/user.js"
    click Middleware "https://github.com/vlyon07/beers4all/blob/main/backend/middleware/authMiddleware.js"
    click Migrations "https://github.com/vlyon07/beers4all/tree/main/backend/migrations"
    click Seeders "https://github.com/vlyon07/beers4all/tree/main/backend/seeders"

    %% Styles
    classDef client fill:#cfe2f3,stroke:#2b5797
    classDef server fill:#d5e8d4,stroke:#82b366
    classDef database fill:#ffe6cc,stroke:#d79b00
    classDef external fill:#e0e0e0,stroke:#666666
    classDef infra fill:#f0e68c,stroke:#b8860b
    classDef config fill:#fff2cc,stroke:#bf9000
    classDef code fill:#f8cecc,stroke:#b85450
```
