Skip to content

Document the frontend/backend indexer contract and add a connection health check #11

Description

@priscaenoch

Problem

The frontend depends on the Octraban indexer (default http://localhost:3001) for all /api/* data, but there is no in-repo documentation of that dependency and no user-facing signal when the backend is unreachable. The relationship is only implicit in scattered fetch calls.

What needs to be done

  • Document, in the README, the endpoints the frontend consumes and the expected backend (octraban_backend indexer on :3001), including the port topology (API :3000, indexer :3001).
  • Add a lightweight startup/connection check against the backend health endpoint and show a clear, non-blocking banner when the indexer is unreachable, with the configured URL.
  • Link the backend repository from the README's setup section.

Files

  • README.md
  • new src/components/BackendStatusBanner.tsx (or extend an existing banner component)
  • src/App.tsx

Acceptance deliverables

  • README documents the frontend/backend contract and ports.
  • When the backend is down, the app shows a clear banner instead of silent failures.

Tests to pass

  • Test: banner appears when the health check fails and is hidden when it succeeds (API client mocked).

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions