Start with the runnable local central-server example. This checks text chat using workspace packages. The standalone application also supports its own login and admin-managed services/providers/accounts; external identity exchange remains pending. Prerequisites: PHP 8.3+, Composer, repository Node 22+ and pnpm 11.19.0. Exact supported runtime evidence and backend setup commands are canonical in local setup.
Prepare and start#
Follow local setup to install the Laravel example, generate its app key, create its SQLite database, migrate/seed demo identities and configure Reverb and origin allowlists. Do not run demo seeders against production.
The repository provides a Windows setup and process launcher. From the root:
./scripts/setup-local.ps1
./scripts/start-lan.ps1 -LanAddress YOUR_LAN_IP -IncludeVueThe launcher starts API, Reverb and UI processes with local logs under .runtime. Stop them with ./scripts/stop-lan.ps1. For manual process commands see local setup. Open http://localhost:3000. A different LAN device uses the server's LAN IP and must have permission to reach ports 3000, 8000 and 8085. API CORS and Reverb origins must include that LAN frontend. Defaults infer the page hostname.
First conversation#
- In one browser profile choose Local demo → Shope → Customer → Open workspace.
- Start a conversation from the Start chat seller button on the product page, then select that conversation in the inbox; send a text message, then attach an image and a PDF (with and without text) to confirm file sharing.
- In a different profile/private window choose Shope → Seller / provider. Select Refresh, open the conversation and reply. Confirm the attachments render as a preview and a named download.
- In a third profile choose Shope → Platform admin; open the conversation, Join as admin, then reply. Its sender role must display admin.
- Choose Nexzan in another profile and confirm the Shope conversation is absent.
The chooser uses seeded local accounts such as [email protected], [email protected], [email protected] and corresponding @nexzan.test accounts, with demo password DemoPassword123!. These are fixtures, not real credentials. [email protected] and [email protected] exercise another store and a second member of the first store team through the API.
To repeat REST checks directly, POST /api/demo/login with JSON email/password; read data.token, then pass Authorization: Bearer <token> to /api/chat/me. All chat responses wrap their resource in data. The token is user-scoped; service/provider identity is resolved server-side.
Integrate your project#
Use the Laravel package for an embedded Laravel backend, or central server for a separately hosted chat backend. Choose React/Next.js, Vue, plain HTML or the headless SDK. Laravel server-rendered hosts also have a Blade path. Non-Laravel authentication exchange remains pending.
For the standalone deployment create the first platform admin with the operator command documented in local setup/deployment. Sign in with that account, create services/providers and user accounts through Administration, and select a service to open its inbox. Real sign-in uses only email/password. Give each website account a distinct email; its stored role and permissions are resolved by the server. For embedded packages configure your existing host identity integration instead. Product/order/booking context is supplied through the documented API; it never grants access by itself. Consult configuration and troubleshooting. Build/runtime checks and remaining production gaps are recorded in compatibility and project status.