phpreaction-frontend-pointofsale-react
Summary
- What it is: A point of sale (POS) interface for PHPReaction, also called “checkout”. Definition .
- Goal: Create a simplified interface for the inscription of sales per steps (headers, content/lines, payments, print receipt).
- Repository: GitHub repository — https://github.com/PHPCreation/phpreaction-frontend-pointofsale-react
- README (clone, run, repo Docker): README.md on default branch — https://github.com/PHPCreation/phpreaction-frontend-pointofsale-react/blob/main/README.md
- Primary users: End users performing sales transactions (cashiers, sales staff).
Features
- Multi-step sales flow (Information, Lines, Payment, Print).
- Invoice creation and editing.
- Client selection and distribution type management.
- Manual line entry with code, price, quantity, type, and slug.
- Inventory generation for products in lines.
- Multiple payment support.
- Print receipt with anonymous link option.
- Keyboard shortcuts for fast navigation across all steps.
- KVS (Key-Value Store) for per-user field visibility toggles.
- KVS-driven boundaries (min/max guardrails) on payment, refund, line and tax inputs.
- Query string support for automated testing and deep linking.
- Internationalization support.
- Status pages for API/config/cache/token diagnostics.
Deployed environments
| Environment | URL |
|---|---|
| Development | https://dev.pointofsale.phpr.link/ |
| Staging | https://staging.pointofsale.phpr.link/ |
| Production | https://pointofsale.phpr.link/ |
Multi-environment setup (react-doc).
Integrations & dependencies
APIs
-
PHPR API Link : https://TENANT.cdk-ecs-dev.phpreaction.com/open-api/v3
-
Account API Link : https://TENANT.dev.account.solidservice.link/api/v1/docs
PHPR Bundles
- Authorization Bundle
- Components Bundle
- Config Bundle
- CRUD Bundle
- DynamoDB Bundle
- Icons Bundle
- Status Bundle
- Utils Bundle
Dependencies & Dependents Apps
-
Dependencies : Apps and services that phpreaction-frontend-pointofsale-react uses
- PHPR API (invoice, client, employee, currency, KVS endpoints)
- Account API (authentication, user info)
- Config API (for tenant/config-based runtime settings)
- DynamoDB cache tables (App cache and Config cache)
- Inspired by phpreaction-frontend-punch-react
-
Dependents : Apps and services that use phpreaction-frontend-pointofsale-react
- (None currently)
Routes
Main Routes :
/[locale]/: Information page - Main entry point for creating/editing an invoice./[locale]/[id]/lines: Lines page - Add products/services to the invoice./[locale]/[id]/payments: Payment page - Process payments for the invoice./[locale]/[id]/print: Print page - Display and print the client receipt./[locale]/support: Support page./[locale]/tenant-not-found: Tenant not found page.
Status Routes :
/[locale]/status/all: List all status page./[locale]/status/api: APIs status page./[locale]/status/cache: Cache status page./[locale]/status/configs: Configs status page./[locale]/status/user-token/check: Checks if user token exists and is valid./[locale]/status/user-token/display: Displays user token information./[locale]/status/user-token/expected: Displays expected user token information
Support Routes :
/[locale]/support: Support page.
Security implementation
- CSRF token validation on sensitive form endpoints.
- Rate limiting for API requests.
- Role-based access control for invoice, employee, client, and KVS operations.
- Secure cookie-based session handling.
Related links
Repo
Docs
Compliance
Last updated on