Skip to content

docs: add local sandbox quickstart - #1673

Open
Epic-Drytu wants to merge 1 commit into
LabsCrypt:mainfrom
Epic-Drytu:docs/local-sandbox-guide
Open

Epic-Drytu wants to merge 1 commit into
LabsCrypt:mainfrom
Epic-Drytu:docs/local-sandbox-guide

Conversation

@Epic-Drytu

Copy link
Copy Markdown

Description

Adds a Local Mock Sandbox section to the Quickstart guide to help developers run FlowFi locally using mock services and seeded data.

Changes Made

  • Documented prerequisites and startup instructions.
  • Explained the local infrastructure and service ports.
  • Added application endpoints and shutdown instructions.
  • Clarified the differences between Local Sandbox and Stellar Testnet.
  • Documented mock RPC limitations.
  • Added troubleshooting guidance and database safety notes.
  • Preserved the existing Testnet quickstart.

Type of Change

  • Documentation update

Testing

  • Docusaurus documentation build
  • git diff --check
  • Manual browser preview

Related Issue

Closes #1664

@Epic-Drytu

Copy link
Copy Markdown
Author

Hi maintainers! Thanks for coordinating the related work.

I noticed PR #1674 also includes the Local Sandbox documentation alongside the frontend component tests. My PR #1673 focuses specifically on the Quickstart documentation for issue #1664, and its automated checks are passing.

I’m happy to coordinate with the other contributor to avoid duplicate documentation. Please let me know whether you’d prefer these contributions to remain separate or be handled together.

Thanks!

This branch has not been deployed

No deployments
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.

[Docs] Add step-by-step Local Mock Sandbox mode guide to docs-site/docs/quickstart.md

1 participant