# domenicocolandrea86/react-vite-typescript-boilerplate architecture

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

- Interactive diagram: https://gitdiagram.com/domenicocolandrea86/react-vite-typescript-boilerplate
- Repository: https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate

## Overview

##### Project type and purpose
- This is a single-page application (SPA) boilerplate focused on front-end development:
– React + TypeScript for UI
– Vite for development server and build
– Tailwind for styling
– Vitest + Testing Library for unit/E2E tests
– ESLint/Prettier for linting & formatting
– Nx as workspace manager
– Pnpm as package manager
– Docker + NGINX for containerized production serving

##### File structure
- Top-level directories:
– /src – React source code
– /public – static assets (favicon, index.html template)
– /docker – Dockerfile + NGINX config
- Configuration files:
– vite.config.ts, tsconfig.json, tailwind.config.js
– ESLint + Prettier rules
– nx.json, pnpm-lock.yaml
- Scripts in package.json handle dev, build, test, lint, formatting, docker tasks.

##### README for architecture hints
- No runtime backend – it’s purely front-end, served as static files by NGINX in production
- Dev flow: “pnpm dev” → Vite starts hot-reload server on localhost:5173
- Production flow: “pnpm build” → Vite outputs /dist → Docker image builds /dist into NGINX → serve on port 80

##### Detail level & granularity
- Every major step: edit, test, build, containerize, serve, run
- Don’t lump “Build & Serve” – separate Vite build from NGINX serve
- Config files (e.g., Dockerfile, NGINX.conf) as part of the build context

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Environment
    subgraph "Developer Workstation"
        dev_gitignore[".gitignore"]:::code
        dev_nx["nx.json"]:::code
        dev_pkg["package.json"]:::code
        dev_pnpm["pnpm-lock.yaml"]:::code
        dev_nvmrc[".nvmrc"]:::code
        dev_eslintrc[".eslintrc"]:::code
        dev_eslintignore[".eslintignore"]:::code
        dev_prettierrc[".prettierrc"]:::code
    end

    %% Local Dev Server
    subgraph "Local Dev Server" 
        vite_cfg["vite.config.ts"]:::runtime
        index_html["index.html"]:::runtime
        main_tsx["src/main.tsx"]:::runtime
        vite_env["src/vite-env.d.ts"]:::runtime
    end

    %% React Application
    subgraph "React Application"
        react_app["/src/app"]:::code
        main_render["/src/main-render"]:::code
    end

    %% Build Pipeline
    subgraph "Build Pipeline"
        bp_vitecfg["vite.config.ts"]:::artifacts
        bp_ts["tsconfig.json"]:::artifacts
        bp_tsnode["tsconfig.node.json"]:::artifacts
    end

    %% Static Assets
    subgraph "Static Assets"
        public_dir["/public"]:::artifacts
        postcss_cfg["postcss.config.js"]:::artifacts
        tailwind_cfg["tailwind.config.js"]:::artifacts
    end

    %% Docker Build Stage
    subgraph "Docker Build Stage"
        dockerfile["/docker/Dockerfile"]:::runtime
        nginx_conf["/docker/nginx/nginx.conf"]:::runtime
        default_conf["/docker/nginx/conf.d/default.conf"]:::runtime
    end

    %% Production Container
    subgraph "Production Container"
        prod_nginx["/docker/nginx/nginx.conf"]:::runtime
        prod_default["/docker/nginx/conf.d/default.conf"]:::runtime
    end

    %% Tooling & Quality Gates
    subgraph "Tooling & Quality Gates"
        hook_precommit["/git-hooks/pre-commit"]:::external
        hook_prepush["/git-hooks/pre-push"]:::external
        test_file["src/app/App.test.tsx"]:::external
        pkg_scripts["package.json (scripts)"]:::external
    end

    %% Client Browser
    browser["Client Browser"]:::external

    %% Connections
    dev_gitignore & dev_nx & dev_pkg & dev_pnpm & dev_nvmrc & dev_eslintrc & dev_eslintignore & dev_prettierrc -->|"code edit & commit"| vite_cfg
    vite_cfg -->|"serves app"| browser
    vite_cfg --> react_app
    react_app --> bp_vitecfg
    bp_vitecfg & bp_ts & bp_tsnode -->|"build produces /dist"| public_dir
    public_dir & postcss_cfg & tailwind_cfg --> dockerfile
    dockerfile --> nginx_conf
    nginx_conf & default_conf --> prod_nginx
    prod_nginx & prod_default -->|serves static files| browser

    dev_pkg --> pkg_scripts
    pkg_scripts --> hook_precommit
    pkg_scripts --> hook_prepush
    hook_precommit & hook_prepush --> test_file
    test_file --> vite_cfg

    %% Click Events
    click dev_gitignore "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main/.gitignore"
    click dev_nx "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//nx.json"
    click dev_pkg "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//package.json"
    click dev_pnpm "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//pnpm-lock.yaml"
    click dev_nvmrc "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//.nvmrc"
    click dev_eslintrc "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//.eslintrc"
    click dev_eslintignore "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//.eslintignore"
    click dev_prettierrc "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//.prettierrc"
    click vite_cfg "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//vite.config.ts"
    click index_html "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//index.html"
    click main_tsx "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//src/main.tsx"
    click vite_env "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//src/vite-env.d.ts"
    click react_app "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/tree/main//src/app"
    click main_render "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/tree/main//src/main-render"
    click bp_vitecfg "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//vite.config.ts"
    click bp_ts "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//tsconfig.json"
    click bp_tsnode "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//tsconfig.node.json"
    click public_dir "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/tree/main//public"
    click postcss_cfg "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//postcss.config.js"
    click tailwind_cfg "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//tailwind.config.js"
    click dockerfile "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/tree/main//docker/Dockerfile"
    click nginx_conf "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//docker/nginx/nginx.conf"
    click default_conf "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//docker/nginx/conf.d/default.conf"
    click prod_nginx "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//docker/nginx/nginx.conf"
    click prod_default "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//docker/nginx/conf.d/default.conf"
    click hook_precommit "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/tree/main//git-hooks/pre-commit"
    click hook_prepush "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/tree/main//git-hooks/pre-push"
    click test_file "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main/src/app/App.test.tsx"
    click pkg_scripts "https://github.com/domenicocolandrea86/react-vite-typescript-boilerplate/blob/main//package.json"

    %% Styles
    classDef code fill:#D0E1FF,stroke:#333,stroke-width:1px
    classDef runtime fill:#D0FFD6,stroke:#333,stroke-width:1px
    classDef artifacts fill:#FFE4B5,stroke:#333,stroke-width:1px
    classDef external fill:#DDDDDD,stroke:#333,stroke-width:1px
```
