This folder describes the target architecture of SaleFlex.GATE and the integration contract with SaleFlex.PyPOS. The application is still maturing; content here is draft and will be updated as API paths and model names stabilize.
| # | Document | Topic |
|---|---|---|
| 1 | 01-ecosystem-and-boundaries.md | GATE in the ecosystem; PyPOS, KITCHEN, mobile, and third-party boundaries |
| 2 | 02-identity-tenancy-and-rbac.md | Accounts, companies, stores, membership, and admin approval |
| 3 | 03-stores-terminals-and-kitchen.md | Registering POS and kitchen apps under a store |
| 4 | 04-rest-api-conventions.md | REST principles, authentication, versioning (draft) |
| 5 | 05-mobile-client-scenarios.md | Management, stocktake, and waiter mobile scenarios |
| 6 | 06-third-party-integrations.md | ERP, loyalty, campaign, and payment integrations |
| 7 | 07-web-ui-erp-and-reporting.md | Django web UI, ERP-style capabilities, reporting |
| 8 | 08-public-web-portal-landing-and-accounts.md | Public landing, register, login, logout, portal password change (web_ui_app, separate from Django Admin); static CSS, icons, JS layout |
| 9 | 09-portal-companies-ownership-and-deletion.md | Portal sidebar, companies (create with optional registration fields, join requests), owner tag vs administrator, multi-owner deletion approvals |
- SaleFlex.PyPOS — Integration Layer
- PyPOS
settings.toml[gate]section:base_url,manages_transactions,manages_campaign, etc.
After pip install -r requirements.txt, run python manage.py makemigrations, then python manage.py migrate, then python manage.py collectstatic --noinput. App migration modules (other than __init__.py) are not committed; each checkout generates them locally. The staticfiles/ directory is not committed; it is created by collectstatic and holds Django Admin and web_ui_app assets for any setup that serves STATIC_ROOT. The root README.md Quick Start and Installation sections repeat this step.
Open an issue or pull request on the GATE repository for corrections or gaps in these drafts.