Skip to content

Create a developer quickstart guide #221

Description

@Marvell69

New contributors need a single document that gets them from a fresh clone to a running local environment. Without this, every new contributor loses hours to setup issues.

Requirements and context

  • Create docs/developer-quickstart.md
  • Cover: prerequisites (Node 20+, pnpm, Stellar CLI, Freighter), clone and install, environment variables (.env.local template), run dev server, run tests, connect to testnet, common errors and fixes
  • Test all instructions on a fresh machine (Windows WSL, macOS, Ubuntu)
  • Link prominently from README

Suggested execution

git checkout -b docs/developer-quickstart
  • Create quickstart guide
  • Verify on fresh environment
  • Add .env.local.example file
  • Link from README

Example commit message
docs: create frontend developer quickstart guide

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave program

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