Skip to content

feat(docs): add "run locally in 5 minutes" quickstart script#225

Open
Macnelson9 wants to merge 1 commit into
Dgetsylver:mainfrom
Macnelson9:feat/f6-quickstart
Open

feat(docs): add "run locally in 5 minutes" quickstart script#225
Macnelson9 wants to merge 1 commit into
Dgetsylver:mainfrom
Macnelson9:feat/f6-quickstart

Conversation

@Macnelson9
Copy link
Copy Markdown

Summary

  • Adds dev/start.sh: single script that checks prereqs, starts stellar/quickstart via Docker (Soroban RPC + Horizon), installs frontend deps, and launches the Vite dev server
  • --testnet flag skips Docker and points directly to Stellar Testnet
  • dev/.env.example documents all supported env vars with defaults
  • Rewrites root README.md with quickstart section, env var table, project layout, test/storybook/CI reference, and contributing link

Test plan

  • bash dev/start.sh — frontend opens at http://localhost:5173 with local node
  • bash dev/start.sh --testnet — testnet banner shows, no Docker required

Closes #73

🤖 Generated with Claude Code

…ver#73)

Adds `dev/start.sh` that checks prereqs, starts stellar/quickstart via
Docker, installs deps, and launches the Vite dev server. `--testnet` flag
skips Docker and points to Stellar Testnet. `dev/.env.example` documents
all env vars. Rewrites root `README.md` with quickstart, env var table,
project layout, and CI reference.

Closes Dgetsylver#73

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

F6: "Run locally in 5 minutes" quickstart

1 participant