Skip to content

Commit b19813d

Browse files
authored
Merge pull request #99 from ury-erp/doc/add_comprehensive_skills_coverage
Added comprehensive skills coverage
2 parents 1b7efae + db81fda commit b19813d

23 files changed

Lines changed: 5756 additions & 358 deletions

File tree

AGENTS.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,58 @@ Ensure new modules are added to `ury/modules.txt` and run `bench migrate`.
303303

304304
---
305305

306+
## Skills Directory
307+
308+
URY includes a modular skills system in `skills/` that provides AI agents with contextual knowledge about specific codebase areas.
309+
310+
### Using the Skills Directory
311+
312+
The `skills/_index.json` file contains a machine-readable index of all 18 available skills with metadata including:
313+
- **name**: Skill identifier
314+
- **description**: What the skill covers
315+
- **category**: backend, frontend, features, quality, ui
316+
- **path**: Location of the skill documentation
317+
- **key_files**: Important files referenced by this skill
318+
- **depends_on**: Other skills this one depends on
319+
- **tags**: Searchable keywords
320+
321+
### Available Skills
322+
323+
| Skill | Category | Description |
324+
|-------|----------|-------------|
325+
| `api-client` | frontend | Frappe SDK wrapper for frontend apps |
326+
| `cart-state` | frontend | Zustand cart state management |
327+
| `custom-fields` | backend | ERPNext custom field extensions |
328+
| `customer-api` | backend | Guest-facing ordering APIs |
329+
| `doctypes` | backend | Core URY data models |
330+
| `frappe-patterns` | backend | Frappe framework patterns |
331+
| `kot-generation` | backend | Kitchen Order Ticket system |
332+
| `menu-hooks` | frontend | React hooks for menu/QR data |
333+
| `monorepo` | frontend | NPM workspaces structure |
334+
| `order-hooks` | frontend | Order lifecycle React hooks |
335+
| `payment-gateway` | backend | Multi-provider payment processing |
336+
| `realtime` | backend | WebSocket/realtime patterns |
337+
| `staff-pos-api` | backend | Staff POS operations APIs |
338+
| `testing` | quality | Testing patterns and workflows |
339+
| `ui-components` | ui | React UI component library |
340+
| `table-order-app` | features | QR Table Ordering application |
341+
| `customer-order-app` | features | Online pickup/delivery ordering |
342+
| `kiosk-app` | features | Self-service kiosk ordering |
343+
344+
### Skill File Format
345+
346+
Each skill is documented in `skills/<skill-name>/SKILL.md` with:
347+
- **Key Files**: Important source files
348+
- **How It Works**: Core patterns and flow
349+
- **Extension Points**: Where to add new functionality
350+
- **Dependencies**: Required packages/modules
351+
- **Gotchas**: Common pitfalls and solutions
352+
353+
---
354+
306355
## Contact & Support
307356

308357
- **Repository**: https://github.com/ury-erp/ury
309358
- **Issues**: Create GitHub issue
310359
- **Documentation**: See `planning/` directory
360+
- **Skills Index**: See `skills/_index.json` for the complete catalog of 18 skills

FEATURES.md

Lines changed: 85 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,93 @@
11
# Features of URY App
22

3-
It's important to note that if no POS Opening entry is created for the day, URY will not allow table selection, ensuring accurate tracking of operations.
4-
A POS Closing Entry must be created at the end of each day to complete the daily operations.
3+
URY is a comprehensive restaurant management system with multi-channel ordering capabilities.
4+
5+
## Multi-App Architecture
6+
7+
URY now supports multiple customer-facing applications in addition to the staff POS:
8+
9+
### Staff Applications
10+
- **POS v2** (`/pos/`) - Desktop/tablet cashier interface
11+
- **POS v1** (`/urypos/`) - Mobile order-taker interface (legacy)
12+
- **Mosaic KDS** (`/URYMosaic/`) - Kitchen Display System
13+
14+
### Customer Applications
15+
- **QR Table Ordering** (`/order/t/<token>`) - Customers scan QR codes to order from tables
16+
- **Online Ordering** (`/menu/<slug>`) - Remote pickup/delivery ordering
17+
- **Kiosk Mode** (`/kiosk/<device>`) - Self-service ordering on touch screens
18+
19+
### Key Features Across All Apps
20+
- Unified menu management
21+
- Real-time order status updates
22+
- Automatic KOT generation
23+
- Integrated payment processing
24+
25+
---
526

627
> :information_source: **Note**
7-
> This version is currently designed for **POS machines/Desktop** to handle **cashiers and fast checkout**.
28+
> It's important to note that if no POS Opening entry is created for the day, URY will not allow table selection, ensuring accurate tracking of operations.
29+
> A POS Closing Entry must be created at the end of each day to complete the daily operations.
30+
31+
> :information_source: **Note**
32+
> The POS v2 is currently designed for **POS machines/Desktop** to handle **cashiers and fast checkout**.
833
> For **order takers and mobile support**, use **Version 1 POS**, which is available at the path `/urypos/Table`.
934
35+
---
36+
37+
## QR Table Ordering
38+
39+
Customers scan QR codes at their tables to place orders directly.
40+
41+
- **QR Code Generation**: Staff generate QR codes for each table with configurable expiry
42+
- **Token-Based Access**: Secure JWT tokens encode restaurant and table context
43+
- **Mobile-Optimized Menu**: Browse menu by categories, view item images and descriptions
44+
- **Cart Management**: Add/remove items, adjust quantities
45+
- **Guest Checkout**: No account required - just name and optional phone
46+
- **Real-Time Status**: Track order status from Placed → Confirmed → Preparing → Ready → Served
47+
- **Call Waiter**: Button to notify staff for assistance
48+
- **Pay at Counter**: Payment handled traditionally after meal
49+
50+
## Online Customer Ordering
51+
52+
Remote ordering for pickup, delivery, or curbside.
53+
54+
- **Restaurant Discovery**: Access via unique slug (`/menu/restaurant-name`)
55+
- **Order Types**: Pickup, Delivery, or Curbside
56+
- **Scheduled Orders**: Order now for pickup later (up to 7 days)
57+
- **Time Slot Selection**: 15-minute interval slots based on restaurant hours
58+
- **Guest Checkout**: Phone-based order tracking, no account needed
59+
- **Order History**: View past orders by phone number
60+
- **Real-Time Tracking**: Live order status updates
61+
- **Payment Integration**: Stripe and Razorpay support
62+
63+
## Kiosk Self-Service
64+
65+
In-store ordering on large touch screens.
66+
67+
- **Attract Screen**: Eye-catching welcome with animations, auto-reset after timeout
68+
- **Large Touch Targets**: Minimum 64px buttons for easy interaction
69+
- **Category Ribbon**: Quick navigation between menu categories
70+
- **Full-Screen Item View**: Large images and descriptions
71+
- **Always-Visible Cart**: Side panel showing current order
72+
- **Dine-In / Takeaway**: Simple selection with large buttons
73+
- **Inactivity Timeout**: 90-second auto-reset to attract screen
74+
- **Order Confirmation**: Large order number display with QR for tracking
75+
- **Device Authentication**: One-time setup with device token
76+
77+
## Payment Gateway
78+
79+
Integrated payment processing for online orders.
80+
81+
- **Multiple Providers**: Stripe and Razorpay supported
82+
- **Payment Methods**: Cards, UPI, wallets (provider-dependent)
83+
- **Webhook Handling**: Automatic payment confirmation
84+
- **Secure**: PCI-compliant hosted checkout
85+
- **Test Mode**: Sandbox support for development
86+
87+
---
88+
89+
## Staff POS v2 Features
90+
1091
- **Key Features**
1192
- All Major POS Features from Version 1 Retained
1293
- Core functionalities from the previous version are preserved for consistency.
@@ -221,4 +302,4 @@ A POS Closing Entry must be created at the end of each day to complete the daily
221302
14. Time Wise Sales
222303

223304
- **Customizable Branch Timings:**
224-
- URY allows you to set varying branch timings in the URY Report settings, including extended hours. This feature ensures that your reports accurately reflect the operational hours of your restaurant.
305+
- URY allows you to set varying branch timings in the URY Report settings, including extended hours. This feature ensures that your reports accurately reflect the operational hours of your restaurant.

0 commit comments

Comments
 (0)