Skip to content

chore: add web/dashboard/README.md #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbdulmujibOladayo merged 1 commit into from
May 13, 2026
Merged

chore: add web/dashboard/README.md #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions web/dashboard/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <http://localhost:5173> 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 |
Loading