Skip to content

Add docs for local development setup from scratch including database and indexer startup #588

Description

@Chucks1093

Summary

New contributors have no single documented path for getting the server running locally from a fresh clone. They end up piecing together setup steps from scattered files which leads to friction and abandoned onboarding attempts.

Scope

  • Document prerequisites: Node version, database engine, Stellar testnet RPC access
  • Step-by-step setup: clone, install dependencies, copy env file, run migrations, seed the database
  • Explain how to start the API server and the indexer separately
  • Add a section on verifying the setup: expected health check response and first creator list response

Acceptance Criteria

  • Prerequisites listed with versions where relevant
  • Setup steps are numbered and sequential
  • API and indexer start commands are both documented
  • Verification steps confirm a working local environment

ETA: 12 hours


Coordinate on Telegram

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions