Stephan D
10a278c65a
Integrate themed login/signup, EN/RU localization, shared dummy providers, verification recovery screens and named URL routes. Store frontend guidelines, workflow skills, validation and delivery documentation. Related to #2, #3, #5 and #6.
44 lines
2.5 KiB
Markdown
44 lines
2.5 KiB
Markdown
# SXCHNGE
|
|
|
|
Product repository for the sxchnge public website, consumer frontend, and backend for frontend (BFF).
|
|
|
|
## Repository structure
|
|
|
|
| Folder | Purpose | Status |
|
|
| --- | --- | --- |
|
|
| [`website/`](website/README.md) | Existing Astro public website, assets, brand references, and Sites configuration | Implemented |
|
|
| [`frontend/`](frontend/README.md) | Consumer application and Flutter packages | Theme, shared auth, localized app, verification and routing implemented |
|
|
| [`backend/`](backend/README.md) | Product BFF integrating with Sendico | Prepared for implementation |
|
|
|
|
Each application owns its dependencies and deployment configuration. The frontend includes the reusable `sxchnge_theme` Flutter package; the backend currently contains documentation only.
|
|
|
|
## Website development
|
|
|
|
Run the existing website commands from its new folder:
|
|
|
|
```sh
|
|
cd website
|
|
npm ci
|
|
npm run dev -- --background --host 127.0.0.1
|
|
npm run test
|
|
npm run check
|
|
npm run build
|
|
```
|
|
|
|
From `website/`, manage the background server with `npm exec astro dev status`, `npm exec astro dev logs`, and `npm exec astro dev stop`. Build output is `website/dist/`. Use `website/` as the working directory for website hosting tools; its existing Sites identity is preserved in `website/.openai/hosting.json`.
|
|
|
|
## Product boundaries
|
|
|
|
The intended integration is: consumer frontend → sxchnge BFF → supported Sendico API.
|
|
|
|
- sxchnge owns consumer registration and sessions, the onboarding and exchange experience, and mapping authenticated consumers to stable organization-scoped Sendico customer references.
|
|
- Sendico remains authoritative for payment execution, KYC records and verification, policy decisions, and limit enforcement.
|
|
- The sxchnge organization, backend integration principal, and individual customer references are distinct identities. Consumers must not share the integration account's customer identity.
|
|
- The BFF should use a supported API contract rather than copying Sendico's existing BFF or depending on its local internal modules.
|
|
|
|
Before implementing the product, define one complete transaction flow and agree on the Sendico customer, KYC, eligibility/limits, and customer-scoped payment contracts. These are intended boundaries, not claims that the required Sendico operations already exist.
|
|
|
|
## Delivery record
|
|
|
|
See [the implementation record](docs/implementation.md) for delivered scope, task mapping, validation, and PR dependencies. Repository workflow skills and frontend guidelines are stored locally under `.agents/skills/` and `frontend/AGENTS.md`.
|