From f9bfea5c838aa272fd199cacd417b2475fa2ae5e Mon Sep 17 00:00:00 2001 From: Leothosine Date: Wed, 13 May 2026 05:03:29 +0100 Subject: [PATCH] chore: add web/dashboard/README.md --- web/dashboard/README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 web/dashboard/README.md diff --git a/web/dashboard/README.md b/web/dashboard/README.md new file mode 100644 index 0000000..9bbd919 --- /dev/null +++ b/web/dashboard/README.md @@ -0,0 +1,36 @@ +# PayStream Dashboard + +React + Vite front-end for the PayStream platform. + +## Running the dev server + +`ash +# From the repo root +pnpm install --no-frozen-lockfile + +# Or from this directory +cd web/dashboard +pnpm install +pnpm dev +` + +The dev server starts at by default. + +## Environment variables + +Copy .env.example to .env and fill in the values: + +| Variable | Description | Default | +|---|---|---| +| NEXT_PUBLIC_API_URL | PayStream API base URL | http://localhost:8080 | +| NEXT_PUBLIC_STELLAR_NETWORK | Stellar network (mainnet or estnet) | estnet | +| NEXT_PUBLIC_HORIZON_URL | Stellar Horizon endpoint | https://horizon-testnet.stellar.org | + +## Other commands + +| Command | Description | +|---|---| +| pnpm build | Production build | +| pnpm typecheck | TypeScript type-check | +| pnpm lint | ESLint | +| pnpm preview | Preview production build locally | \ No newline at end of file