Expand the README with environment configuration and the full route map

[mikewheeleer]

Document environment configuration and the complete route map in the README

Description

README.md describes the stack and basic commands but lists a project structure that only mentions layout.tsx, page.tsx, and page.test.tsx — it is badly out of date now that the app ships ~15 routes (services, usage, agents, admin, stats, events, webhooks, api-keys, search, settings, docs, export, about, changelog) and shared components/lib. It also never documents the required NEXT_PUBLIC_AGENTPAY_API_BASE env var read in src/lib/apiClient.ts. This issue brings the README up to date.

Requirements and context

• Repository scope: Agentpay-Org/Agentpay-frontend only.
• Add an "Environment variables" section documenting NEXT_PUBLIC_AGENTPAY_API_BASE (purpose, default http://localhost:3001, that it is public).
• Replace the stale project-structure tree with the real layout under src/app/, src/components/, and src/lib/.
• Add a route map table mapping each path to its purpose and the backend endpoints it calls (cross-reference src/app/docs/page.tsx).
• Document npm run typecheck (present in package.json but unmentioned).

Suggested execution

• Fork the repo and create a branch
• git checkout -b docs/docs-29-readme-env-and-routes
• Implement changes
  • Write code in: README.md (docs only).
  • Write comprehensive tests in: not applicable; instead verify every documented path exists under src/app/ and every command exists in package.json.
  • Add documentation: this issue is the documentation.
  • Validate links resolve and the structure tree matches the repo.
• Test and commit

Test and commit

• Run npm run lint and npm run build to confirm nothing references removed content.
• Cross-check the route table against the actual files in src/app/.
• Include a note confirming each command in the README runs.

Example commit message

docs(readme): document env config and full route map

Guidelines

• Accuracy over completeness; every claim must match the code.
• Clear, reviewer-focused documentation.
• Timeframe: 96 hours.

Community & contribution rewards

• 💬 Join the AgentPay community on Discord for questions, reviews, and faster merges: https://discord.gg/eXvRKkgcv
• ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — if this issue and the maintainers helped you ship, we'd be grateful for a 5-star rating. Clear questions in Discord and tidy, well-tested PRs are the fastest path to a merge and a reward.