Skip to content

Commit b308926

Browse files
changed spellings
1 parent 94ad910 commit b308926

41 files changed

Lines changed: 56 additions & 56 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.MD

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The system covers the full restaurant workflow: menu management, table managemen
2121
ury/ ← repo root
2222
├── ury/ ← Frappe app Python package (main backend)
2323
├── pos/ ← React 19 POS frontend (v2, current)
24-
├── Mosaic/ ← Vue 3 KOT kitchen display app
24+
├── mosaic/ ← Vue 3 KOT kitchen display app
2525
├── urypos/ ← Vue 3 POS frontend (v1, legacy)
2626
├── DEMO/ ← Demo screenshots / assets
2727
├── requirements.txt ← Python dependencies
@@ -30,7 +30,7 @@ ury/ ← repo root
3030
└── FEATURES.md / README.md ← Human-readable documentation
3131
```
3232

33-
The Yarn workspace (`package.json`) at the root manages three JS sub-projects: `pos/`, `Mosaic/`, and `urypos/`.
33+
The Yarn workspace (`package.json`) at the root manages three JS sub-projects: `pos/`, `mosaic/`, and `urypos/`.
3434

3535
---
3636

@@ -82,7 +82,7 @@ ury/
8282
│ │ ├── ury_pos_kot.js ← KOT related JS
8383
│ │ └── sign-message.js / jsrsasign-all-min.js ← QZ Tray signing
8484
│ ├── pos/ ← Built React POS assets (output of `cd pos && yarn build`)
85-
│ ├── Mosaic/ ← Built KOT display assets
85+
│ ├── mosaic/ ← Built KOT display assets
8686
│ └── urypos/ ← Built legacy POS assets
8787
8888
├── fixtures/ ← Data fixtures exported via `bench export-fixtures`
@@ -166,16 +166,16 @@ ury/
166166
### Frontend Apps
167167
- **`/pos`** — React POS v2 (see `pos/AGENTS.MD`)
168168
- **`/urypos`** — Vue POS v1 (legacy, `urypos/`)
169-
- **`/Mosaic/<production_unit>`** — Vue KOT display (see `Mosaic/AGENTS.MD`)
169+
- **`/mosaic/<production_unit>`** — Vue KOT display (see `mosaic/AGENTS.MD`)
170170

171171
All frontends are served as Frappe web pages. Route rules in `hooks.py` (`website_route_rules`) handle SPA routing:
172172
```python
173173
{"from_route": "/pos/<path:app_path>", "to_route": "pos"},
174-
{"from_route": "/Mosaic/<path:app_path>", "to_route": "Mosaic"},
174+
{"from_route": "/mosaic/<path:app_path>", "to_route": "mosaic"},
175175
```
176176

177177
### Real-time (Socket.io)
178-
- KOT updates are broadcast via Frappe's Socket.io to the `Mosaic` kitchen display.
178+
- KOT updates are broadcast via Frappe's Socket.io to the `mosaic` kitchen display.
179179
- Channel format: `kot_update_{branch}_{production_unit}`
180180

181181
### QZ Tray
@@ -190,13 +190,13 @@ All frontends are served as Frappe web pages. Route rules in `hooks.py` (`websit
190190
| App | Source | Build output | URL |
191191
|---|---|---|---|
192192
| POS v2 (React) | `pos/src/` | `ury/public/pos/` | `/pos` |
193-
| KOT display (Vue) | `Mosaic/src/` | `ury/public/Mosaic/` | `/Mosaic/<unit>` |
193+
| KOT display (Vue) | `mosaic/src/` | `ury/public/mosaic/` | `/mosaic/<unit>` |
194194
| POS v1 (Vue, legacy) | `urypos/src/` | `ury/public/urypos/` | `/urypos` |
195195

196196
Build commands (from repo root):
197197
```bash
198198
cd pos && yarn build # builds React POS
199-
cd Mosaic && yarn build # builds KOT display
199+
cd mosaic && yarn build # builds KOT display
200200
cd urypos && yarn build # builds legacy POS
201201
```
202202

@@ -212,7 +212,7 @@ After building, run `bench build --app ury` to copy assets to the Frappe public
212212
→ Work in `pos/`. Read `pos/AGENTS.MD` first.
213213

214214
**To modify KOT display logic:**
215-
→ Work in `Mosaic/`. Read `Mosaic/AGENTS.MD` first.
215+
→ Work in `mosaic/`. Read `mosaic/AGENTS.MD` first.
216216

217217
**To add or modify a Frappe API endpoint:**
218218
→ Edit `ury/ury_pos/api.py` (main POS API) or `ury/ury/api/<module>.py`.
@@ -235,6 +235,6 @@ After building, run `bench build --app ury` to copy assets to the Frappe public
235235
→ Hook registration is in `hooks.py` `doc_events`.
236236

237237
**Never:**
238-
- Modify `ury/public/pos/`, `ury/public/Mosaic/`, or `ury/public/urypos/` directly — these are build output, not source.
238+
- Modify `ury/public/pos/`, `ury/public/mosaic/`, or `ury/public/urypos/` directly — these are build output, not source.
239239
- Edit `fixtures/custom_field.json` directly — export from Frappe desk instead.
240240
- Add business logic to `www/pos.py` — it should only return boot context data.

FEATURES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ A POS Closing Entry must be created at the end of each day to complete the daily
139139
- Each production unit has its own dedicated web-based interface, displaying specific items.
140140
- Printers can be configured separately for each production unit.
141141
- KDS displays are organised by these units , access KDS via
142-
`/Mosaic/<URY_Production_Unit>`
142+
`/mosaic/<URY_Production_Unit>`
143143

144144
- **KOT Display**
145145
- KDS make easy to monitor kitchen orders (KOTs) on a screen..

SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ This guide takes you step-by-step through setting up URY on top of ERPNext
250250
- **KOT Print Format** : Select print format for KOT .
251251
- **Block Takeaway KOT** : Enable for block Takeaway KOT printing .
252252

253-
> **Note:** To access KDS follow the site url with `/Mosaic/Production%20Unit%20Name`. eg: [https://ury.xxxx.com/Mosaic/Kitchen](https://ury.xxx.com/Mosaic/Kitchen)
253+
> **Note:** To access KDS follow the site url with `/mosaic/Production%20Unit%20Name`. eg: [https://ury.xxxx.com/mosaic/Kitchen](https://ury.xxx.com/mosaic/Kitchen)
254254
255255
### Step 11 : User Permissions
256256

File renamed without changes.

Mosaic/AGENTS.MD renamed to mosaic/AGENTS.MD

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Mosaic — Agent Documentation
1+
# mosaic — Agent Documentation
22

33
## 1. Overview
44

5-
**Mosaic** is a Vue 3 real-time Kitchen Order Ticket (KOT) display system. It runs on a screen in the kitchen and shows live order tickets as they are placed or modified by the POS. Kitchen staff use it to track what to prepare and mark orders as served.
5+
**mosaic** is a Vue 3 real-time Kitchen Order Ticket (KOT) display system. It runs on a screen in the kitchen and shows live order tickets as they are placed or modified by the POS. Kitchen staff use it to track what to prepare and mark orders as served.
66

7-
- **URL:** `/Mosaic/<production_unit_name>` (e.g., `/Mosaic/Kitchen`)
8-
- **Served as:** Frappe web page (`ury/www/Mosaic.html`)
9-
- **Build output:** `ury/public/Mosaic/`
7+
- **URL:** `/mosaic/<production_unit_name>` (e.g., `/mosaic/Kitchen`)
8+
- **Served as:** Frappe web page (`ury/www/mosaic.html`)
9+
- **Build output:** `ury/public/mosaic/`
1010

1111
The production unit name in the URL determines which KOTs are displayed. Each physical kitchen station has its own URL pointing to its production unit.
1212

@@ -29,7 +29,7 @@ The production unit name in the URL determines which KOTs are displayed. Each ph
2929
## 3. Project Structure
3030

3131
```
32-
Mosaic/
32+
mosaic/
3333
├── src/
3434
│ ├── main.js ← Vue app entry point
3535
│ ├── App.vue ← Root component: mounts Header + KOT
@@ -207,7 +207,7 @@ KOTs are hidden from the board by setting `kot.showDiv = true` (not by removing
207207
`audio_alert` is fetched from the backend (`POS Profile` / `URY Printer Settings`). Audio only plays if `audio_alert === 1` AND the user has clicked the page at least once (browser autoplay policy). The `showAudioAlertMessage` banner guides users to click.
208208

209209
### Authentication
210-
If `auth()` fails, `this.showModal = true` shows a "Not Permitted / Login" modal. The redirect goes to `/login?redirect-to=Mosaic/{production}`. Do not remove this auth check.
210+
If `auth()` fails, `this.showModal = true` shows a "Not Permitted / Login" modal. The redirect goes to `/login?redirect-to=mosaic/{production}`. Do not remove this auth check.
211211

212212
### What NOT to change
213213
- The `kot_channel` computation — changing it breaks real-time updates.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8" />
55
<link rel="icon" href="/ury.ico" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>URY Mosaic</title>
7+
<title>URY mosaic</title>
88
</head>
99
<body>
1010
<div id="app"></div>

0 commit comments

Comments
 (0)