# astrollll/brother_bean_pos architecture

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

- Interactive diagram: https://gitdiagram.com/astrollll/brother_bean_pos
- Repository: https://github.com/astrollll/brother_bean_pos

## Overview

Brother Bean POS is a browser-based coffee-shop point-of-sale and back-office application. A cashier records a sale in the POS controller; order persistence handles offline queuing and recipe-based stock deduction, while the POS also updates kitchen and sales state and can print a receipt. Administrators manage the menu, inventory, staff, expenses, settings, and sales analytics. Firebase provides authentication and Firestore persistence, with local caching or fallback in several models. The graph reflects documented imports and excerpted calls; unsampled capabilities are represented only where the README or source index supports them.

Main entry points: [`controllers/admin/adminPortalController.js`](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/admin/adminPortalController.js) (Admin portal), [`controllers/posController.js`](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/posController.js) (POS workflow), [`models/orderModel.js`](https://github.com/astrollll/brother_bean_pos/blob/main/models/orderModel.js) (Order processing), [`models/inventoryModel.js`](https://github.com/astrollll/brother_bean_pos/blob/main/models/inventoryModel.js) (Inventory and recipes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_front["POS and administration"]
  node_pos["POS workflow<br/>[posController.js]"]
  node_admin["Admin portal"]
  node_login["Login flow<br/>[loginController.js]"]
  node_analytics["Sales analytics<br/>[dashboardView.js]"]
  node_menuview["Menu view<br/>[menuView.js]"]
end

subgraph group_commerce["Sales and catalog"]
  node_menu["Menu management<br/>[menuModel.js]"]
  node_categories["Categories<br/>[categoryModel.js]"]
  node_seed["Default catalog<br/>[defaultSeedData.js]"]
  node_orders["Order processing<br/>[orderModel.js]"]
end

subgraph group_operations["Shop operations"]
  node_inventory["Inventory and recipes<br/>[inventoryModel.js]"]
  node_expenses[("Expense tracking<br/>[expenseModel.js]")]
  node_staff[("Staff management<br/>[staffModel.js]")]
  node_settings[("Shop settings<br/>[settingsModel.js]")]
  node_printer["Thermal printing<br/>[thermalPrinter.js]"]
end

subgraph group_platform["Persistence and services"]
  node_auth["Firebase auth<br/>[firebaseAuth.js]"]
  node_storage[("POS and kitchen storage<br/>[storageModel.js]")]
  node_firebase["Firebase setup<br/>[firebase.js]"]
end

node_cashier(("Cashier"))
node_firestore[("Firestore")]
node_bluetooth["Bluetooth printer"]

node_cashier -->|"records sale"| node_pos
node_pos -->|"saves order"| node_orders
node_pos -->|"saves kitchen order"| node_storage
node_pos -->|"persists POS state"| node_storage
node_pos -->|"records expense"| node_expenses
node_pos -->|"reads receipt settings"| node_settings
node_pos -->|"gets user"| node_auth
node_pos -.->|"prints receipt"| node_printer
node_orders -->|"deducts recipe stock"| node_inventory
node_orders -->|"queues offline order"| node_storage
node_admin -->|"manages menu"| node_menu
node_admin -->|"manages categories"| node_categories
node_admin -->|"loads orders"| node_orders
node_admin -->|"manages inventory"| node_inventory
node_admin -->|"manages staff"| node_staff
node_admin -->|"loads expenses"| node_expenses
node_admin -->|"saves settings"| node_settings
node_admin -->|"renders analytics"| node_analytics
node_admin -.->|"uses menu view"| node_menuview
node_admin -->|"connects printer"| node_printer
node_login -->|"authenticates"| node_auth
node_menu -->|"loads templates"| node_seed
node_menuview -.->|"uses stock data"| node_inventory
node_firebase -->|"initializes"| node_firestore
node_auth -->|"uses auth setup"| node_firebase
node_storage -->|"reads and writes"| node_firestore
node_inventory -->|"reads and writes"| node_firestore
node_orders -->|"persists orders"| node_firestore
node_expenses -->|"syncs expenses"| node_firestore
node_printer -.->|"connects over BLE"| node_bluetooth

click node_pos "https://github.com/astrollll/brother_bean_pos/blob/main/controllers/posController.js"
click node_admin "https://github.com/astrollll/brother_bean_pos/blob/main/controllers/admin/adminPortalController.js"
click node_login "https://github.com/astrollll/brother_bean_pos/blob/main/controllers/auth/loginController.js"
click node_auth "https://github.com/astrollll/brother_bean_pos/blob/main/controllers/auth/firebaseAuth.js"
click node_menu "https://github.com/astrollll/brother_bean_pos/blob/main/models/menuModel.js"
click node_categories "https://github.com/astrollll/brother_bean_pos/blob/main/models/categoryModel.js"
click node_seed "https://github.com/astrollll/brother_bean_pos/blob/main/models/defaultSeedData.js"
click node_orders "https://github.com/astrollll/brother_bean_pos/blob/main/models/orderModel.js"
click node_inventory "https://github.com/astrollll/brother_bean_pos/blob/main/models/inventoryModel.js"
click node_storage "https://github.com/astrollll/brother_bean_pos/blob/main/models/storageModel.js"
click node_expenses "https://github.com/astrollll/brother_bean_pos/blob/main/models/expenseModel.js"
click node_staff "https://github.com/astrollll/brother_bean_pos/blob/main/models/staffModel.js"
click node_settings "https://github.com/astrollll/brother_bean_pos/blob/main/models/settingsModel.js"
click node_analytics "https://github.com/astrollll/brother_bean_pos/blob/main/views/dashboardView.js"
click node_menuview "https://github.com/astrollll/brother_bean_pos/blob/main/views/menuView.js"
click node_printer "https://github.com/astrollll/brother_bean_pos/blob/main/controllers/printer/thermalPrinter.js"
click node_firebase "https://github.com/astrollll/brother_bean_pos/blob/main/controllers/firebase.js"

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_pos,node_admin,node_login,node_analytics,node_menuview toneBlue
class node_menu,node_categories,node_seed,node_orders,node_firestore toneAmber
class node_inventory,node_expenses,node_staff,node_settings,node_printer toneMint
class node_auth,node_storage,node_firebase toneRose
class node_cashier,node_bluetooth toneIndigo
```

## Components

### POS and administration

- [POS workflow](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/posController.js): `controllers/posController.js`
- [Admin portal](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/admin/adminPortalController.js): `controllers/admin/adminPortalController.js`
- [Login flow](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/auth/loginController.js): `controllers/auth/loginController.js`
- [Sales analytics](https://github.com/astrollll/brother_bean_pos/blob/main/views/dashboardView.js): `views/dashboardView.js`
- [Menu view](https://github.com/astrollll/brother_bean_pos/blob/main/views/menuView.js): `views/menuView.js`

### Sales and catalog

- [Menu management](https://github.com/astrollll/brother_bean_pos/blob/main/models/menuModel.js): `models/menuModel.js`
- [Categories](https://github.com/astrollll/brother_bean_pos/blob/main/models/categoryModel.js): `models/categoryModel.js`
- [Default catalog](https://github.com/astrollll/brother_bean_pos/blob/main/models/defaultSeedData.js): `models/defaultSeedData.js`
- [Order processing](https://github.com/astrollll/brother_bean_pos/blob/main/models/orderModel.js): `models/orderModel.js`

### Shop operations

- [Inventory and recipes](https://github.com/astrollll/brother_bean_pos/blob/main/models/inventoryModel.js): `models/inventoryModel.js`
- [Expense tracking](https://github.com/astrollll/brother_bean_pos/blob/main/models/expenseModel.js): `models/expenseModel.js`
- [Staff management](https://github.com/astrollll/brother_bean_pos/blob/main/models/staffModel.js): `models/staffModel.js`
- [Shop settings](https://github.com/astrollll/brother_bean_pos/blob/main/models/settingsModel.js): `models/settingsModel.js`
- [Thermal printing](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/printer/thermalPrinter.js): `controllers/printer/thermalPrinter.js`

### Persistence and services

- [Firebase auth](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/auth/firebaseAuth.js): `controllers/auth/firebaseAuth.js`
- [POS and kitchen storage](https://github.com/astrollll/brother_bean_pos/blob/main/models/storageModel.js): `models/storageModel.js`
- [Firebase setup](https://github.com/astrollll/brother_bean_pos/blob/main/controllers/firebase.js): `controllers/firebase.js`

### Other components

- **Cashier**
- **Firestore**
- **Bluetooth printer**

## Connections

- Cashier → POS workflow: records sale (evidence: `controllers/posController.js`)
- POS workflow → Order processing: saves order (evidence: `controllers/posController.js`)
- POS workflow → POS and kitchen storage: saves kitchen order (evidence: `controllers/posController.js`)
- POS workflow → POS and kitchen storage: persists POS state (evidence: `controllers/posController.js`)
- POS workflow → Expense tracking: records expense (evidence: `controllers/posController.js`)
- POS workflow → Shop settings: reads receipt settings (evidence: `controllers/posController.js`)
- POS workflow → Firebase auth: gets user (evidence: `controllers/posController.js`)
- POS workflow → Thermal printing: prints receipt (evidence: `controllers/posController.js`)
- Order processing → Inventory and recipes: deducts recipe stock (evidence: `models/orderModel.js`)
- Order processing → POS and kitchen storage: queues offline order (evidence: `models/orderModel.js`)
- Admin portal → Menu management: manages menu (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Categories: manages categories (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Order processing: loads orders (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Inventory and recipes: manages inventory (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Staff management: manages staff (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Expense tracking: loads expenses (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Shop settings: saves settings (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Sales analytics: renders analytics (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Menu view: uses menu view (evidence: `controllers/admin/adminPortalController.js`)
- Admin portal → Thermal printing: connects printer (evidence: `controllers/admin/adminPortalController.js`)
- Login flow → Firebase auth: authenticates (evidence: `controllers/auth/loginController.js`)
- Menu management → Default catalog: loads templates (evidence: `models/menuModel.js`)
- Menu view → Inventory and recipes: uses stock data (evidence: `views/menuView.js`)
- Firebase setup → Firestore: initializes (evidence: `controllers/firebase.js`)
- Firebase auth → Firebase setup: uses auth setup (evidence: `controllers/auth/firebaseAuth.js`)
- POS and kitchen storage → Firestore: reads and writes (evidence: `models/storageModel.js`)
- Inventory and recipes → Firestore: reads and writes (evidence: `models/inventoryModel.js`)
- Order processing → Firestore: persists orders (evidence: `models/orderModel.js`)
- Expense tracking → Firestore: syncs expenses (evidence: `models/expenseModel.js`)
- Thermal printing → Bluetooth printer: connects over BLE
