# les-saucisses-qui-piquent/crafted-to-go architecture

> Architecture diagram of the GitHub repository les-saucisses-qui-piquent/crafted-to-go, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/les-saucisses-qui-piquent/crafted-to-go
- Repository: https://github.com/les-saucisses-qui-piquent/crafted-to-go

## Overview

##### Project type and purpose
- This is a full-stack, click-and-collect “Crafted to Go” web & mobile app in a single monorepo.
- It comprises three coordinated services (web client, API server, database) orchestrated via Docker Compose.
- Purpose: allow customers to browse artisanal beers, place orders, and enable breweries to manage inventory.

##### File structure
- Top level:
- docker-compose.yaml – ties together three Docker services
- “api” folder – Node.js/TypeScript Fastify server with Prisma and MVC-style controllers & repositories
- “database” folder – Postgres setup, Prisma migrations, seeding/faker scripts
- “web” folder – React/Expo (web & native) using file-based routing, contexts, hooks, Tailwind CSS
- Patterns & conventions:
- api/src/controllers → business logic endpoints
- api/src/repository → data-access layer following Repository pattern
- prisma/schema.prisma & migrations → source of truth for relational model
- web/app → file-based routing (Next-style or Expo router) separating customer vs brewery flows
- shared contexts & utils in “web/contexts” and “web/utils”

##### README for additional insights
- Mono-repo npm scripts to start/stop/reset all or specific services
- E2E testing configured via Maestro/EAS for Android/web
- Standard dev workflow: Docker Compose up/stop, Prisma migrations, Expo builds

##### Diagramming recommendations
- Blue rectangles for containers (Web, API, DB)
- UI → HTTP request → API Route
- Controller → Repository → Prisma Client → DB
- If needed, show CI/CD: GitHub Actions CI → Docker image builds → Maestro E2E tests.

##### Detail without overthinking
- Every logical component (e.g., auth.middleware, token util, faker scripts) where it impacts data flow or responsibilities.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Docker Compose Network"  
        style DockerComposeNetwork fill:none,stroke:none

        subgraph "Web Client (React/Expo)"  
            style WebClient fill:#D0E8FF,stroke:#0366d6,stroke-width:2px
            Router["File-based Routing\n(web/app)"]:::module
            Components["UI Components\n(web/components)"]:::module
            Contexts["Contexts & State\n(web/contexts)"]:::module
            Hooks["Custom Hooks\n(web/hooks)"]:::module
            Utils["Utilities\n(web/utils)"]:::module
            StyleConfig["Tailwind Config\n(web/tailwind.config.js)"]:::module
            GlobalCSS["Global CSS\n(web/global.css)"]:::module
        end

        subgraph "API Server (Fastify)"  
            style APIServer fill:#D0E8FF,stroke:#0366d6,stroke-width:2px
            Routes["Routes\n(api/src/routes)"]:::module
            Controllers["Controllers\n(api/src/controllers)"]:::module
            Repositories["Repositories\n(api/src/repository)"]:::module
            Middleware["Auth & CORS\n(api/src/middlewares & api/src/plugins)"]:::module
            APIUtils["Utilities\n(api/utils)"]:::module
            PrismaClient["Prisma Client\n(api/prisma)"]:::module
        end

        subgraph "Database (PostgreSQL)"  
            style Database fill:#fff5b1,stroke:#dcb200,stroke-width:2px
            DBPrisma["Prisma Schema & Migrations\n(database/prisma)"]:::module
            DBScripts["Seed & Faker Scripts\n(database/scripts)"]:::module
            Postgres["PostgreSQL\n(port 5432)"]:::db
        end
    end

    %% Interactions
    Components -->|"uses"| Router
    Contexts -->|"provides state to"| Components
    Hooks -->|"enhances"| Components
    Utils -->|"called by"| Components
    StyleConfig -->|"styles applied to"| Components
    GlobalCSS -->|"styles applied to"| Components

    Router -->|"HTTP requests"| Routes
    Middleware -->|"middleware for"| Routes
    Routes -->|"invokes"| Controllers
    APIUtils -->|"helpers for"| Controllers
    Controllers -->|"calls"| Repositories
    Repositories -->|"executes queries via"| PrismaClient
    PrismaClient -->|"reads/writes"| Postgres
    DBScripts -->|"populate data in"| Postgres
    DBPrisma -->|"defines schema for"| Postgres

    %% Click Events - Web Client
    click Router "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/web/app"
    click Components "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/web/components"
    click Contexts "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/web/contexts"
    click Hooks "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/web/hooks"
    click Utils "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/web/utils"
    click StyleConfig "https://github.com/les-saucisses-qui-piquent/crafted-to-go/blob/dev/web/tailwind.config.js"
    click GlobalCSS "https://github.com/les-saucisses-qui-piquent/crafted-to-go/blob/dev/web/global.css"

    %% Click Events - API Server
    click Routes "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/api/src/routes"
    click Controllers "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/api/src/controllers"
    click Repositories "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/api/src/repository"
    click Middleware "https://github.com/les-saucisses-qui-piquent/crafted-to-go/blob/dev/api/src/middlewares/auth.middleware.ts"
    click APIUtils "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/api/utils"
    click PrismaClient "https://github.com/les-saucisses-qui-piquent/crafted-to-go/blob/dev/api/prisma/schema.prisma"

    %% Click Events - Database
    click DBPrisma "https://github.com/les-saucisses-qui-piquent/crafted-to-go/blob/dev/database/prisma/schema.prisma"
    click DBScripts "https://github.com/les-saucisses-qui-piquent/crafted-to-go/tree/dev/database/scripts"

    classDef container fill:#D0E8FF,stroke:#0366d6,stroke-width:2px
    classDef module fill:#e6ffed,stroke:#2c662d,stroke-width:1px
    classDef db fill:#fff5b1,stroke:#dcb200,stroke-width:2px
```
