# ayush758/robot-shop architecture

> Architecture diagram of the GitHub repository ayush758/robot-shop, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ayush758/robot-shop
- Repository: https://github.com/ayush758/robot-shop

## Overview

Stan’s Robot Shop is a containerized sample online store. A shopper uses the browser storefront, which is served by the web tier; the storefront then uses backend services for catalog, cart, user, ratings, shipping and payment. The README documents Compose, DC/OS, Kubernetes/Helm and OpenShift deployment options, plus load generation, Prometheus metrics and Instana monitoring. Backend services and several infrastructure integrations are represented from the tree and README, but their wiring is not fully evidenced by the sampled source, so those connections are omitted.

Main entry points: [`web/static/js/controller.js`](https://github.com/ayush758/robot-shop/blob/master/web/static/js/controller.js) (Web storefront), [`shipping/src/main/java/com/instana/robotshop/shipping/Controller.java`](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Controller.java) (Shipping API), [`ratings/html/src/Kernel.php`](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Kernel.php) (Ratings wiring), [`ratings/html/src/Controller/RatingsApiController.php`](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Controller/RatingsApiController.php) (Ratings API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_storefront["Storefront"]
  node_web["Web storefront<br/>[controller.js]"]
  node_webserver["Web server"]
end

subgraph group_commerce["Commerce services"]
  node_catalogue["Catalogue API<br/>[server.js]"]
  node_cart["Cart API<br/>[server.js]"]
  node_user["User API<br/>[server.js]"]
  node_ratings["Ratings API"]
  node_ratingskernel["Ratings wiring<br/>[Kernel.php]"]
  node_ratingsservices["Ratings services<br/>[RatingsService.php]"]
  node_ratingscatalogue["Catalogue lookup"]
  node_ratinghealth["Ratings health"]
  node_healthcheck["Health check"]
  node_ratingsdb["Ratings DB connector<br/>[Database.php]"]
  node_shipping["Shipping API<br/>[Controller.java]"]
  node_shippingcalc["Shipping calculator<br/>[Calculator.java]"]
  node_carthelper["Cart confirmation helper<br/>[CartHelper.java]"]
  node_payment["Payment service<br/>[payment.py]"]
  node_dispatch["Dispatch service<br/>[main.go]"]
end

subgraph group_persistence["Data services"]
  node_cityrepo["City repository"]
  node_coderepo["Code repository"]
  node_city["City entity<br/>[City.java]"]
  node_code["Code entity<br/>[Code.java]"]
  node_mysql[("MySQL store<br/>[20-ratings.sql]")]
  node_mongo[("MongoDB data<br/>[catalogue.js]")]
end

subgraph group_platform["Runtime and observability"]
  node_rabbit["RabbitMQ integration<br/>[rabbitmq.py]"]
  node_shippingapp["Shipping runtime"]
  node_monitoring["Instana monitoring"]
  node_loadgen["Load generator<br/>[robot-shop.py]"]
  node_deploy["Deployment manifests"]
end

node_shopper(("Shopper"))

node_shopper -->|"browses"| node_web
node_web -->|"served by"| node_webserver
node_web -.->|"uses catalog"| node_catalogue
node_web -.->|"manages cart"| node_cart
node_web -.->|"uses accounts"| node_user
node_web -.->|"uses ratings"| node_ratings
node_web -.->|"requests shipping"| node_shipping
node_web -.->|"requests payment"| node_payment
node_ratings -->|"reads and updates"| node_ratingsservices
node_ratings -->|"checks SKU"| node_ratingscatalogue
node_ratingscatalogue -->|"checks product"| node_catalogue
node_ratingskernel -->|"registers routes"| node_ratings
node_ratingskernel -->|"registers controller"| node_ratinghealth
node_ratingskernel -->|"configures service"| node_ratingsservices
node_ratingskernel -->|"configures service"| node_ratingscatalogue
node_ratinghealth -->|"checks connectivity"| node_healthcheck
node_healthcheck -.->|"queries"| node_mysql
node_ratingsservices -.->|"reads and writes"| node_mysql
node_shipping -->|"queries cities"| node_cityrepo
node_shipping -->|"queries codes"| node_coderepo
node_shipping -->|"calculates distance"| node_shippingcalc
node_shipping -->|"confirms cart"| node_carthelper
node_cityrepo -->|"loads entities"| node_city
node_coderepo -->|"loads entities"| node_code
node_carthelper -->|"calls cart"| node_cart
node_shippingapp -.->|"runs service"| node_shipping
node_payment -->|"publishes payment"| node_rabbit
node_dispatch -.->|"consumes events"| node_rabbit
node_catalogue -.->|"uses catalogue data"| node_mongo
node_loadgen -.->|"generates traffic"| node_web
node_deploy -.->|"deploys service"| node_webserver
node_monitoring -.->|"traces and monitors"| node_web
node_monitoring -.->|"traces and monitors"| node_catalogue
node_monitoring -.->|"traces and monitors"| node_cart
node_monitoring -.->|"traces and monitors"| node_payment

click node_web "https://github.com/ayush758/robot-shop/blob/master/web/static/js/controller.js"
click node_webserver "https://github.com/ayush758/robot-shop/blob/master/web/default.conf.template"
click node_catalogue "https://github.com/ayush758/robot-shop/blob/master/catalogue/server.js"
click node_cart "https://github.com/ayush758/robot-shop/blob/master/cart/server.js"
click node_user "https://github.com/ayush758/robot-shop/blob/master/user/server.js"
click node_ratings "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Controller/RatingsApiController.php"
click node_ratingskernel "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Kernel.php"
click node_ratingsservices "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Service/RatingsService.php"
click node_ratingscatalogue "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Service/CatalogueService.php"
click node_ratinghealth "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Controller/HealthController.php"
click node_healthcheck "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Service/HealthCheckService.php"
click node_ratingsdb "https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Database.php"
click node_shipping "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Controller.java"
click node_shippingcalc "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Calculator.java"
click node_carthelper "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/CartHelper.java"
click node_cityrepo "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/CityRepository.java"
click node_coderepo "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/CodeRepository.java"
click node_city "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/City.java"
click node_code "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Code.java"
click node_mysql "https://github.com/ayush758/robot-shop/blob/master/mysql/scripts/20-ratings.sql"
click node_mongo "https://github.com/ayush758/robot-shop/blob/master/mongo/catalogue.js"
click node_payment "https://github.com/ayush758/robot-shop/blob/master/payment/payment.py"
click node_rabbit "https://github.com/ayush758/robot-shop/blob/master/payment/rabbitmq.py"
click node_dispatch "https://github.com/ayush758/robot-shop/blob/master/dispatch/main.go"
click node_shippingapp "https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/ShippingServiceApplication.java"
click node_loadgen "https://github.com/ayush758/robot-shop/blob/master/load-gen/robot-shop.py"
click node_deploy "https://github.com/ayush758/robot-shop/blob/master/K8s/helm/templates/web-deployment.yaml"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web,node_webserver toneBlue
class node_catalogue,node_cart,node_user,node_ratings,node_ratingskernel,node_ratingsservices,node_ratingscatalogue,node_ratinghealth,node_healthcheck,node_ratingsdb,node_shipping,node_shippingcalc,node_carthelper,node_payment,node_dispatch toneAmber
class node_cityrepo,node_coderepo,node_city,node_code,node_mysql,node_mongo toneMint
class node_rabbit,node_shippingapp,node_monitoring,node_loadgen,node_deploy toneRose
class node_shopper toneIndigo
```

## Components

### Storefront

- [Web storefront](https://github.com/ayush758/robot-shop/blob/master/web/static/js/controller.js): `web/static/js/controller.js`
- [Web server](https://github.com/ayush758/robot-shop/blob/master/web/default.conf.template): `web/default.conf.template`

### Commerce services

- [Catalogue API](https://github.com/ayush758/robot-shop/blob/master/catalogue/server.js): `catalogue/server.js`
- [Cart API](https://github.com/ayush758/robot-shop/blob/master/cart/server.js): `cart/server.js`
- [User API](https://github.com/ayush758/robot-shop/blob/master/user/server.js): `user/server.js`
- [Ratings API](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Controller/RatingsApiController.php): `ratings/html/src/Controller/RatingsApiController.php`
- [Ratings wiring](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Kernel.php): `ratings/html/src/Kernel.php`
- [Ratings services](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Service/RatingsService.php): `ratings/html/src/Service/RatingsService.php`
- [Catalogue lookup](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Service/CatalogueService.php): `ratings/html/src/Service/CatalogueService.php`
- [Ratings health](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Controller/HealthController.php): `ratings/html/src/Controller/HealthController.php`
- [Health check](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Service/HealthCheckService.php): `ratings/html/src/Service/HealthCheckService.php`
- [Ratings DB connector](https://github.com/ayush758/robot-shop/blob/master/ratings/html/src/Database.php): `ratings/html/src/Database.php`
- [Shipping API](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Controller.java): `shipping/src/main/java/com/instana/robotshop/shipping/Controller.java`
- [Shipping calculator](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Calculator.java): `shipping/src/main/java/com/instana/robotshop/shipping/Calculator.java`
- [Cart confirmation helper](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/CartHelper.java): `shipping/src/main/java/com/instana/robotshop/shipping/CartHelper.java`
- [Payment service](https://github.com/ayush758/robot-shop/blob/master/payment/payment.py): `payment/payment.py`
- [Dispatch service](https://github.com/ayush758/robot-shop/blob/master/dispatch/main.go): `dispatch/main.go`

### Data services

- [City repository](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/CityRepository.java): `shipping/src/main/java/com/instana/robotshop/shipping/CityRepository.java`
- [Code repository](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/CodeRepository.java): `shipping/src/main/java/com/instana/robotshop/shipping/CodeRepository.java`
- [City entity](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/City.java): `shipping/src/main/java/com/instana/robotshop/shipping/City.java`
- [Code entity](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/Code.java): `shipping/src/main/java/com/instana/robotshop/shipping/Code.java`
- [MySQL store](https://github.com/ayush758/robot-shop/blob/master/mysql/scripts/20-ratings.sql): `mysql/scripts/20-ratings.sql`
- [MongoDB data](https://github.com/ayush758/robot-shop/blob/master/mongo/catalogue.js): `mongo/catalogue.js`

### Runtime and observability

- [RabbitMQ integration](https://github.com/ayush758/robot-shop/blob/master/payment/rabbitmq.py): `payment/rabbitmq.py`
- [Shipping runtime](https://github.com/ayush758/robot-shop/blob/master/shipping/src/main/java/com/instana/robotshop/shipping/ShippingServiceApplication.java): `shipping/src/main/java/com/instana/robotshop/shipping/ShippingServiceApplication.java`
- **Instana monitoring**
- [Load generator](https://github.com/ayush758/robot-shop/blob/master/load-gen/robot-shop.py): `load-gen/robot-shop.py`
- [Deployment manifests](https://github.com/ayush758/robot-shop/blob/master/K8s/helm/templates/web-deployment.yaml): `K8s/helm/templates/web-deployment.yaml`

### Other components

- **Shopper**

## Connections

- Shopper → Web storefront: browses (evidence: `README.md`)
- Web storefront → Web server: served by (evidence: `README.md`)
- Web storefront → Catalogue API: uses catalog
- Web storefront → Cart API: manages cart
- Web storefront → User API: uses accounts
- Web storefront → Ratings API: uses ratings
- Web storefront → Shipping API: requests shipping
- Web storefront → Payment service: requests payment
- Ratings API → Ratings services: reads and updates (evidence: `ratings/html/src/Controller/RatingsApiController.php`)
- Ratings API → Catalogue lookup: checks SKU (evidence: `ratings/html/src/Controller/RatingsApiController.php`)
- Catalogue lookup → Catalogue API: checks product (evidence: `ratings/html/src/Service/CatalogueService.php`)
- Ratings wiring → Ratings API: registers routes (evidence: `ratings/html/src/Kernel.php`)
- Ratings wiring → Ratings health: registers controller (evidence: `ratings/html/src/Kernel.php`)
- Ratings wiring → Ratings services: configures service (evidence: `ratings/html/src/Kernel.php`)
- Ratings wiring → Catalogue lookup: configures service (evidence: `ratings/html/src/Kernel.php`)
- Ratings health → Health check: checks connectivity (evidence: `ratings/html/src/Controller/HealthController.php`)
- Health check → MySQL store: queries
- Ratings services → MySQL store: reads and writes
- Shipping API → City repository: queries cities (evidence: `shipping/src/main/java/com/instana/robotshop/shipping/Controller.java`)
- Shipping API → Code repository: queries codes (evidence: `shipping/src/main/java/com/instana/robotshop/shipping/Controller.java`)
- Shipping API → Shipping calculator: calculates distance (evidence: `shipping/src/main/java/com/instana/robotshop/shipping/Controller.java`)
- Shipping API → Cart confirmation helper: confirms cart (evidence: `shipping/src/main/java/com/instana/robotshop/shipping/Controller.java`)
- City repository → City entity: loads entities (evidence: `shipping/src/main/java/com/instana/robotshop/shipping/CityRepository.java`)
- Code repository → Code entity: loads entities (evidence: `shipping/src/main/java/com/instana/robotshop/shipping/CodeRepository.java`)
- Cart confirmation helper → Cart API: calls cart
- Shipping runtime → Shipping API: runs service
- Payment service → RabbitMQ integration: publishes payment (evidence: `payment/payment.py`)
- Dispatch service → RabbitMQ integration: consumes events
- Catalogue API → MongoDB data: uses catalogue data
- Load generator → Web storefront: generates traffic (evidence: `README.md`)
- Deployment manifests → Web server: deploys service (evidence: `README.md`)
- Instana monitoring → Web storefront: traces and monitors (evidence: `README.md`)
- Instana monitoring → Catalogue API: traces and monitors (evidence: `README.md`)
- Instana monitoring → Cart API: traces and monitors (evidence: `README.md`)
- Instana monitoring → Payment service: traces and monitors (evidence: `README.md`)
