# acasinha/spa-tur architecture

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

- Interactive diagram: https://gitdiagram.com/acasinha/spa-tur
- Repository: https://github.com/acasinha/spa-tur

## Overview

SPA-TUR is a municipal tourism-recording application: staff sign in, choose a module, and record or review visitor, sales, inventory, and monthly nationality data. The router loads module views; their workflows use Firebase/Firestore, while dashboard and administration provide analysis and access management. Offline caching and synchronization support continued use without connectivity. README documentation is only a title, so feature coverage follows the named source modules and sampled code; unsampled modules are represented by their exact view paths, without guessing their internal calls.

Main entry points: [`js/router.js`](https://github.com/acasinha/spa-tur/blob/main/js/router.js) (View router), [`views/inicio/view.js`](https://github.com/acasinha/spa-tur/blob/main/views/inicio/view.js) (Module shortcuts), [`views/registo/view.js`](https://github.com/acasinha/spa-tur/blob/main/views/registo/view.js) (Daily visitor log), [`views/editor/view.js`](https://github.com/acasinha/spa-tur/blob/main/views/editor/view.js) (Monthly editor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App shell"]
  node_shell["App shell<br/>[app-shell.js]"]
  node_login["Sign in<br/>[login.js]"]
  node_router["View router<br/>[router.js]"]
  node_home["Module shortcuts<br/>[view.js]"]
end

subgraph group_records["Visitor records"]
  node_registo["Daily visitor log<br/>[view.js]"]
  node_editor["Monthly editor<br/>[view.js]"]
  node_editorcore["Editor logic<br/>[editor.js]"]
  node_dashboardview["Dashboard view<br/>[view.js]"]
  node_dashboard["Dashboard logic<br/>[dashboard.js]"]
  node_ui["Form UI<br/>[ui.js]"]
end

subgraph group_operations["Operations"]
  node_sales["Sales and stock<br/>[view.js]"]
  node_inventory["Promotional inventory<br/>[view.js]"]
  node_admin["User administration<br/>[view.js]"]
  node_users["User management<br/>[users.js]"]
end

subgraph group_platform["Identity and offline"]
  node_api["API client<br/>[api.js]"]
  node_auth["Session authentication<br/>[auth.js]"]
  node_offline["Offline support<br/>[offline.js]"]
  node_sync["Data synchronization<br/>[sync.js]"]
  node_serviceworker["Service worker<br/>[sw.js]"]
  node_pwa["PWA setup<br/>[pwa.js]"]
end

node_staff(("Staff"))
node_firebase[("Firebase services")]

node_staff -->|"opens"| node_shell
node_shell -->|"initializes"| node_router
node_staff -->|"signs in"| node_login
node_login -->|"authenticates"| node_auth
node_router -->|"loads view"| node_home
node_router -->|"loads view"| node_registo
node_router -->|"loads view"| node_editor
node_router -->|"loads view"| node_dashboardview
node_router -->|"loads view"| node_sales
node_router -->|"loads view"| node_inventory
node_router -->|"loads view"| node_admin
node_home -->|"navigates"| node_router
node_editor -.->|"uses logic"| node_editorcore
node_registo -.->|"uses form UI"| node_ui
node_dashboardview -.->|"uses logic"| node_dashboard
node_admin -.->|"manages accounts"| node_users
node_registo -.->|"reads and writes"| node_firebase
node_editor -.->|"reads and writes"| node_firebase
node_dashboardview -->|"reads and writes"| node_firebase
node_sales -->|"reads and writes"| node_firebase
node_inventory -->|"reads and writes"| node_firebase
node_home -->|"queries indicators"| node_firebase
node_api -.->|"gets token"| node_auth
node_offline -.->|"queues changes"| node_sync
node_serviceworker -->|"dispatches sync"| node_sync
node_pwa -.->|"registers"| node_serviceworker

click node_shell "https://github.com/acasinha/spa-tur/blob/main/js/app-shell.js"
click node_login "https://github.com/acasinha/spa-tur/blob/main/js/login.js"
click node_router "https://github.com/acasinha/spa-tur/blob/main/js/router.js"
click node_home "https://github.com/acasinha/spa-tur/blob/main/views/inicio/view.js"
click node_registo "https://github.com/acasinha/spa-tur/blob/main/views/registo/view.js"
click node_editor "https://github.com/acasinha/spa-tur/blob/main/views/editor/view.js"
click node_editorcore "https://github.com/acasinha/spa-tur/blob/main/js/editor.js"
click node_dashboardview "https://github.com/acasinha/spa-tur/blob/main/views/dashboard/view.js"
click node_dashboard "https://github.com/acasinha/spa-tur/blob/main/js/dashboard.js"
click node_sales "https://github.com/acasinha/spa-tur/blob/main/views/vendas/view.js"
click node_inventory "https://github.com/acasinha/spa-tur/blob/main/views/inventario/view.js"
click node_admin "https://github.com/acasinha/spa-tur/blob/main/views/admin/view.js"
click node_users "https://github.com/acasinha/spa-tur/blob/main/js/users.js"
click node_ui "https://github.com/acasinha/spa-tur/blob/main/js/ui.js"
click node_api "https://github.com/acasinha/spa-tur/blob/main/js/api.js"
click node_auth "https://github.com/acasinha/spa-tur/blob/main/js/auth.js"
click node_offline "https://github.com/acasinha/spa-tur/blob/main/js/offline.js"
click node_sync "https://github.com/acasinha/spa-tur/blob/main/js/sync.js"
click node_serviceworker "https://github.com/acasinha/spa-tur/blob/main/sw.js"
click node_pwa "https://github.com/acasinha/spa-tur/blob/main/js/pwa.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_shell,node_login,node_router,node_home toneBlue
class node_registo,node_editor,node_editorcore,node_dashboardview,node_dashboard,node_ui,node_firebase toneAmber
class node_sales,node_inventory,node_admin,node_users toneMint
class node_api,node_auth,node_offline,node_sync,node_serviceworker,node_pwa toneRose
class node_staff toneIndigo
```

## Components

### App shell

- [App shell](https://github.com/acasinha/spa-tur/blob/main/js/app-shell.js): `js/app-shell.js`
- [Sign in](https://github.com/acasinha/spa-tur/blob/main/js/login.js): `js/login.js`
- [View router](https://github.com/acasinha/spa-tur/blob/main/js/router.js): `js/router.js`
- [Module shortcuts](https://github.com/acasinha/spa-tur/blob/main/views/inicio/view.js): `views/inicio/view.js`

### Visitor records

- [Daily visitor log](https://github.com/acasinha/spa-tur/blob/main/views/registo/view.js): `views/registo/view.js`
- [Monthly editor](https://github.com/acasinha/spa-tur/blob/main/views/editor/view.js): `views/editor/view.js`
- [Editor logic](https://github.com/acasinha/spa-tur/blob/main/js/editor.js): `js/editor.js`
- [Dashboard view](https://github.com/acasinha/spa-tur/blob/main/views/dashboard/view.js): `views/dashboard/view.js`
- [Dashboard logic](https://github.com/acasinha/spa-tur/blob/main/js/dashboard.js): `js/dashboard.js`
- [Form UI](https://github.com/acasinha/spa-tur/blob/main/js/ui.js): `js/ui.js`

### Operations

- [Sales and stock](https://github.com/acasinha/spa-tur/blob/main/views/vendas/view.js): `views/vendas/view.js`
- [Promotional inventory](https://github.com/acasinha/spa-tur/blob/main/views/inventario/view.js): `views/inventario/view.js`
- [User administration](https://github.com/acasinha/spa-tur/blob/main/views/admin/view.js): `views/admin/view.js`
- [User management](https://github.com/acasinha/spa-tur/blob/main/js/users.js): `js/users.js`

### Identity and offline

- [API client](https://github.com/acasinha/spa-tur/blob/main/js/api.js): `js/api.js`
- [Session authentication](https://github.com/acasinha/spa-tur/blob/main/js/auth.js): `js/auth.js`
- [Offline support](https://github.com/acasinha/spa-tur/blob/main/js/offline.js): `js/offline.js`
- [Data synchronization](https://github.com/acasinha/spa-tur/blob/main/js/sync.js): `js/sync.js`
- [Service worker](https://github.com/acasinha/spa-tur/blob/main/sw.js): `sw.js`
- [PWA setup](https://github.com/acasinha/spa-tur/blob/main/js/pwa.js): `js/pwa.js`

### Other components

- **Staff**
- **Firebase services**

## Connections

- Staff → App shell: opens
- App shell → View router: initializes
- Staff → Sign in: signs in
- Sign in → Session authentication: authenticates (evidence: `js/auth.js`)
- View router → Module shortcuts: loads view (evidence: `js/router.js`)
- View router → Daily visitor log: loads view (evidence: `js/router.js`)
- View router → Monthly editor: loads view (evidence: `js/router.js`)
- View router → Dashboard view: loads view (evidence: `js/router.js`)
- View router → Sales and stock: loads view (evidence: `js/router.js`)
- View router → Promotional inventory: loads view (evidence: `js/router.js`)
- View router → User administration: loads view (evidence: `js/router.js`)
- Module shortcuts → View router: navigates (evidence: `views/inicio/view.js`)
- Monthly editor → Editor logic: uses logic
- Daily visitor log → Form UI: uses form UI
- Dashboard view → Dashboard logic: uses logic
- User administration → User management: manages accounts
- Daily visitor log → Firebase services: reads and writes
- Monthly editor → Firebase services: reads and writes
- Dashboard view → Firebase services: reads and writes (evidence: `views/dashboard/view.js`)
- Sales and stock → Firebase services: reads and writes (evidence: `views/vendas/view.js`)
- Promotional inventory → Firebase services: reads and writes (evidence: `views/inventario/view.js`)
- Module shortcuts → Firebase services: queries indicators (evidence: `views/inicio/view.js`)
- API client → Session authentication: gets token
- Offline support → Data synchronization: queues changes
- Service worker → Data synchronization: dispatches sync (evidence: `sw.js`)
- PWA setup → Service worker: registers
