# nutritionix/nutrition-label architecture

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

- Interactive diagram: https://gitdiagram.com/nutritionix/nutrition-label
- Repository: https://github.com/nutritionix/nutrition-label

## Overview

##### Project Type and Purpose
- This is an open-source, front-end jQuery plugin (“nutrition-label-jquery-plugin”) that renders FDA-style nutrition labels in any web page.
- It has no backend or server components; it’s delivered as static CSS/JS assets, with demo pages and a build/distribution pipeline (npm, bower).

##### File‐Structure Analysis
- Top‐Level:
- package.json, bower.json: dependency & build metadata
- .eslintrc.js: coding‐standard config
- README.md, LICENSE, changelog.txt: documentation
- index.html: root demo page
- “src” isn’t present; the live source is in the project root:
- nutritionLabel.js/.css + their “-min” variants
- “dist/”: the build output (minified CSS/JS, copy of demos and assets)
- “demo/”: working demos (2018-version, legacy-version, uk-version)
- “node_modules/” and “bower_components/” aren’t checked in but implied by package.json/bower.json

##### Core Components to Highlight
A. Plugin Core
- CSS module (nutritionLabel.css)
- JS module (nutritionLabel.js)
B. External Dependencies
- jQuery (v1.8+ from CDN or local)
- Google Fonts (Archivo Black)
C. Build & Packaging
- npm scripts (package.json) → transpile/minify → dist/js & dist/css
- bower.json → front-end dependency manager
D. Demo Harness
- Static HTML pages under /demo and /dist/demo illustrating usage scenarios
- demo CSS overrides (demo/css/) and demo images

##### Relationships & Data Flow
1. Developer installs via npm or bower
2. Page loads external assets:
- <link> to Google Fonts
- <link> to nutritionLabel-min.css
- <script> jQuery → nutritionLabel-min.js
3. Page supplies nutrition data (JSON object) to plugin initialization
4. Plugin (JS) generates HTML structure, applies CSS rules
5. Rendered nutrition label appears in DOM
6. Demo pages exercise various options (locale variants, rounding rules, custom footers)

##### Architectural Patterns & Principles
- Modular front-end plugin: single responsibility (render label UI from data)
- Build pipeline separates source and distribution artifacts
- Versioned demos ensure backward compatibility (legacy vs 2018 vs UK)
- Extensibility: plugin accepts configuration object for custom nutrient lines, rounding, styling

## Diagram (Mermaid)

```mermaid
graph TB
  subgraph "Developer Environment"
    NPMPKG["npm & scripts"]:::build
    click NPMPKG "https://github.com/nutritionix/nutrition-label/blob/master//package.json"
    BOWER["bower.json"]:::build
    click BOWER "https://github.com/nutritionix/nutrition-label/blob/master//bower.json"
    ES[".eslintrc.js"]:::build
    click ES "https://github.com/nutritionix/nutrition-label/blob/master//.eslintrc.js"
  end

  subgraph "Plugin Assets"
    subgraph Source
      CSS_SRC["nutritionLabel.css"]:::code
      click CSS_SRC "https://github.com/nutritionix/nutrition-label/blob/master//nutritionLabel.css"
      CSS_MIN_SRC["nutritionLabel-min.css"]:::code
      click CSS_MIN_SRC "https://github.com/nutritionix/nutrition-label/blob/master//nutritionLabel-min.css"
      JS_SRC["nutritionLabel.js"]:::code
      click JS_SRC "https://github.com/nutritionix/nutrition-label/blob/master//nutritionLabel.js"
      JS_MIN_SRC["nutritionLabel-min.js"]:::code
      click JS_MIN_SRC "https://github.com/nutritionix/nutrition-label/blob/master//nutritionLabel-min.js"
    end
    subgraph Distribution
      CSS_DIST["dist/css/nutritionLabel.css"]:::code
      click CSS_DIST "https://github.com/nutritionix/nutrition-label/blob/master//dist/css/nutritionLabel.css"
      CSS_MIN_DIST["dist/css/nutritionLabel-min.css"]:::code
      click CSS_MIN_DIST "https://github.com/nutritionix/nutrition-label/blob/master//dist/css/nutritionLabel-min.css"
      JS_DIST["dist/js/nutritionLabel.js"]:::code
      click JS_DIST "https://github.com/nutritionix/nutrition-label/blob/master//dist/js/nutritionLabel.js"
      JS_MIN_DIST["dist/js/nutritionLabel-min.js"]:::code
      click JS_MIN_DIST "https://github.com/nutritionix/nutrition-label/blob/master//dist/js/nutritionLabel-min.js"
      STABLE_CSS["nutritionLabel-stable-ver-11.0.4.css"]:::code
      click STABLE_CSS "https://github.com/nutritionix/nutrition-label/blob/master//nutritionLabel-stable-ver-11.0.4.css"
      STABLE_JS["nutritionLabel-stable-ver-11.0.4.js"]:::code
      click STABLE_JS "https://github.com/nutritionix/nutrition-label/blob/master//nutritionLabel-stable-ver-11.0.4.js"
    end
  end

  subgraph "External Services"
    JQ["jQuery (CDN)"]:::external
    GF["Google Fonts CDN"]:::external
  end

  subgraph "Demo / Consumer Page"
    subgraph "Source Demo"
      DEMO_HTML["/demo/demo.html"]:::consumer
      click DEMO_HTML "https://github.com/nutritionix/nutrition-label/blob/master//demo/demo.html"
      DEMO_2018["2018-version"]:::consumer
      click DEMO_2018 "https://github.com/nutritionix/nutrition-label/tree/master//demo/2018-version/"
      DEMO_LEG["legacy-version"]:::consumer
      click DEMO_LEG "https://github.com/nutritionix/nutrition-label/tree/master//demo/legacy-version/"
      DEMO_UK["uk-version"]:::consumer
      click DEMO_UK "https://github.com/nutritionix/nutrition-label/tree/master//demo/uk-version/"
      DEMO_CSS["demo/css/demo.css"]:::consumer
      click DEMO_CSS "https://github.com/nutritionix/nutrition-label/blob/master//demo/css/demo.css"
      DEMO_MCSS["demo/css/demo-mobile.css"]:::consumer
      click DEMO_MCSS "https://github.com/nutritionix/nutrition-label/blob/master//demo/css/demo-mobile.css"
      DEMO_IMG["demo/images"]:::consumer
      click DEMO_IMG "https://github.com/nutritionix/nutrition-label/tree/master//demo/images/"
      DEMO_IMG2["demo/demo_images"]:::consumer
      click DEMO_IMG2 "https://github.com/nutritionix/nutrition-label/tree/master//demo/demo_images/"
    end
    subgraph "Distribution Demo"
      DDEMO_HTML["dist/demo/demo.html"]:::consumer
      click DDEMO_HTML "https://github.com/nutritionix/nutrition-label/blob/master//dist/demo/demo.html"
      DDEMO_2018["2018-version"]:::consumer
      click DDEMO_2018 "https://github.com/nutritionix/nutrition-label/tree/master//dist/demo/2018-version/"
      DDEMO_LEG["legacy-version"]:::consumer
      click DDEMO_LEG "https://github.com/nutritionix/nutrition-label/tree/master//dist/demo/legacy-version/"
      DDEMO_UK["uk-version"]:::consumer
      click DDEMO_UK "https://github.com/nutritionix/nutrition-label/tree/master//dist/demo/uk-version/"
      DDEMO_CSS["dist/demo/css/demo.css"]:::consumer
      click DDEMO_CSS "https://github.com/nutritionix/nutrition-label/blob/master//dist/demo/css/demo.css"
      DDEMO_MCSS["dist/demo/css/demo-mobile.css"]:::consumer
      click DDEMO_MCSS "https://github.com/nutritionix/nutrition-label/blob/master//dist/demo/css/demo-mobile.css"
      DDEMO_IMG["dist/demo/images"]:::consumer
      click DDEMO_IMG "https://github.com/nutritionix/nutrition-label/tree/master//dist/demo/images/"
      DDEMO_IMG2["dist/demo/demo_images"]:::consumer
      click DDEMO_IMG2 "https://github.com/nutritionix/nutrition-label/tree/master//dist/demo/demo_images/"
    end
  end

  DOM["Rendered Nutrition Label in DOM"]:::runtime

  NPMPKG -->|"build"| CSS_DIST
  NPMPKG -->|"build"| JS_DIST
  BOWER -->|"install"| CSS_DIST
  BOWER -->|"install"| JS_DIST

  DEMO_HTML -->|"<link> nutritionLabel-min.css"| CSS_MIN_DIST
  DEMO_HTML -->|"<script> nutritionLabel-min.js"| JS_MIN_DIST
  DEMO_HTML -->|"init(pluginOptions)"| JS_MIN_DIST
  DEMO_HTML -->|"provides data"| JS_MIN_DIST
  JS_MIN_DIST -->|"render"| DOM

  JQ -->|"<script>"| DEMO_HTML
  GF -->|"<link>"| DEMO_HTML

  classDef code fill:#D0E6FF,stroke:#0066CC;
  classDef external fill:#DFFFD0,stroke:#33AA00;
  classDef build fill:#FFE0B2,stroke:#FF8800;
  classDef consumer fill:#E0E0E0,stroke:#888888;
  classDef runtime fill:#F0F0F0,stroke:#444444;
```
