Navigation Index

Complete app documentation - all menus, features, and technical details

🌐 Public Pages (No Login Required)

Home / Dashboard

/Dashboard
Public (All Users)

Main landing page with hero slider, widgets, and dynamic content

Features:

  • Hero slider with promotional slides
  • Elfsight widgets (Google Maps, Number Counter)
  • Why Choose section
  • Conditional sign-in/welcome back message

Entities Used:

HeroSlide, WidgetConfig, SiteContent, User

Functions Called:

N/A

Components:

HeroSlider, ElfsightWidget, Logo

Pricing

/Pricing
Public (All Users)

Display pricing plans with member discounts and Square payment integration

Features:

  • View all active pricing plans
  • Member discount calculation (50% off)
  • Location selection for purchase
  • Square checkout integration
  • Plan comparison display

Entities Used:

PricingPlan, LockerLocation, User, AppConfig

Functions Called:

createSquareCheckoutLink

Components:

SubscriptionModal

👤 Authenticated User Pages

Payments / Orders

/Orders
Authenticated Users (admin, user)

User dashboard with multiple tabs for managing orders, payments, coupons, and profile

Sub-tabs:

📑 Orders

View user's locker orders with status tracking

Entities: LockerOrder, LockerLocation

Key Features:

  • Display order details (order_no, trackNo, pickup_code)
  • Show locker location information
  • Order status badges

📑 Payments

View payment history from Square and legacy Airtable

Entities: SquarePayment, SquareTransaction, PricingPlan

Key Features:

  • Square payment details with receipt links
  • Legacy Airtable transaction data
  • Payment status tracking

📑 FOBs

View and manage assigned key fobs

Entities: KeyLog

Key Features:

  • View FOB parcel numbers
  • Pickup codes for FOBs
  • Custom internal reference naming

📑 Coupons

View and share assigned discount coupons

Entities: UserCouponAssignment, SquareCoupon, LockerLocation

Key Features:

  • View assigned active coupons
  • Share coupon via native share API
  • View redemption locations

📑 Profile

Manage user profile and payment methods

Entities: User, UserPaymentMethod, AppConfig

Key Features:

  • Update display name and contact number
  • View locker admin code
  • Request locker code email

Entities Used:

N/A

Functions Called:

N/A

Components:

OrdersTab, PaymentsTab, FobsTab, CouponsTab, ProfileTab, PaymentMethodsManager

AI Assistant

/Assistant
Authenticated Users (admin, user)

Chat interface with AI agent for customer support

Features:

  • Real-time chat with AI agent
  • Agent can access entities (ToDo, Orders, etc.)
  • WhatsApp integration link
  • Message history management
  • File attachment support

Entities Used:

User

Functions Called:

N/A

Components:

MessageBubble

🏪 Shop Owner Pages

My Shop Coupons

/ShopOwnerCoupons
Shop Owners Only

Shop owners view and manage their assigned coupons and redemptions

Features:

  • View coupons assigned to shop owner
  • See redemption statistics (Square vs tracked)
  • View detailed redemption history with customer info
  • Share coupons via customizable template
  • Sync coupon usage data
  • Export redemption data

Entities Used:

SquareCoupon, SquareOrder, User, LockerLocation, AppConfig

Functions Called:

shopOwnerSync

🔐 Admin Pages

Admin Panel

/Admin
Admin Only

Main admin dashboard with multiple management tabs

Sub-tabs:

📑 Plans

Manage pricing plans

Entities: PricingPlan, AppConfig

📑 Payments

View all Square payments and orders

Entities: SquarePayment, SquareOrder, User

📑 Transactions

Legacy Airtable transactions

Entities: SquareTransaction, User

📑 Orders

Legacy locker orders

Entities: LockerOrder, User

📑 FOBs

Manage key logs

Entities: KeyLog, User

📑 Subscriptions

Manage user subscriptions

Entities: UserSubscription, User, PricingPlan

📑 Coupons

Manage Square coupons and assignments

Entities: SquareCoupon, UserCouponAssignment, User

Entities Used:

N/A

Functions Called:

N/A

Admin Log

/AdminLog
Admin Only

Document workflows and track system changes

Entities Used:

AdminWorkflowLog, SystemLog

Functions Called:

N/A

App Settings

/AppSettings
Admin Only

Configure app appearance, content, and settings

Sub-tabs:

📑 Hero Slides

Entities: HeroSlide

📑 Widgets

Entities: WidgetConfig

📑 Content

Entities: SiteContent

📑 UI Settings

Entities: AppConfig

📑 Data Config

Entities: AppConfig, PricingPlan

📑 Square Config

Entities Used:

N/A

Functions Called:

N/A

Users

/Users
Admin Only

Manage users and email templates

Entities Used:

User, EmailTemplate

Functions Called:

N/A

Locations

/Locations
Admin Only

Manage physical locker locations

Entities Used:

LockerLocation

Functions Called:

N/A

Sync Data

/Sync
Admin Only

Synchronize data from external sources (Square, Airtable)

Entities Used:

SquarePayment, SquareOrder, SquareCoupon, UserSubscription

Functions Called:

syncSquareData, syncSquareCoupons, syncAirtableData, testSquareConnection

Financial Reports

/Financial
Admin Only

View financial analytics and reports

Entities Used:

SquarePayment, SquareOrder, UserSubscription, SquareCoupon

Functions Called:

N/A

HomePricing