# YeePOS Documentation

YeePOS is a professional, high-performance Point of Sale (POS) system for WooCommerce. Built as a Progressive Web App (PWA), it provides a native-like experience on any device while maintaining real-time synchronization with your WooCommerce store.

### Core Capabilities

- ### Full PWA Support →

  Install on iOS/Android with custom icons and offline caching.

- ### Smart Sync Filters →

  Control exactly which products and categories sync to your POS.

- ### Lightning Fast API →

  Optimized endpoints for massive catalogs and instant search.

## Installation

1. Upload the `yeepos` plugin folder to your WordPress site.
2. Activate the plugin in Plugins > Installed Plugins.
3. Navigate to the new YeePOS menu in your WordPress dashboard.
4. Configure your branding settings and open the POS interface.

Note: YeePOS requires an active SSL certificate (HTTPS) for PWA features like "Add to Home Screen" to work correctly.

## PWA & Branding

Make the POS yours. Go to YeePOS > Settings > Settings APP PWA to customize:

- App Name: The name displayed when installed on mobile devices.
- Theme Color: Sets the color of the browser address bar and UI elements.
- Theme Icon: Upload a 512x512 PNG to serve as the app icon.
- Background Color: The color shown during the app splash screen.

## Product Filters

Located at YeePOS > Settings > Product Filters, these settings determine what data is synchronized with your local POS database.

- Include Products: Search and select specific products to show.
- Exclude Products: Specifically hide products from the POS.
- Category Whitelist/Blacklist: Filter entire groups of products at once.

Important: Changes to filters require a "Sync Now" action within the POS application to reflect the new product list.

## Add-ons System

YeePOS features a modular add-on architecture for extended functionality:

- Product Add-on: Support for WooCommerce Product Add-ons (Toppings, custom text).
- QR Menu: Self-service ordering system for dine-in customers.
- Restaurant Management: Advanced kitchen coordination and table management.

## REST API Sync

YeePOS uses custom, highly-optimized REST API endpoints located at `/wp-json/yeepos/v1/`. These endpoints are designed to be 20x lighter than standard WooCommerce API responses, ensuring smooth performance even on low-end mobile hardware.

## FAQ

Q: Does YeePOS work offline?
A: Yes. YeePOS uses IndexedDB to cache your product catalog. You can create carts and browse products without an internet connection. An internet connection is only required for the final checkout sync.

Q: Can I use my existing receipt printer?
A: YeePOS supports standard browser printing. Any printer recognized by your device (Windows, Mac, iOS, Android) will work seamlessly.