Skip to content

Documentation & Examples | Write a docs/deployment.md guide for deploying StellarKit API to production #426

Description

@Sulex45

Developers who want to self-host StellarKit API have no guidance on production deployment. Write a docs/deployment.md guide covering the recommended deployment options — running directly with Node.js, using a Dockerfile, and deploying to a platform like Railway or Render. Include environment variable configuration for production, recommended NODE_ENV settings, health check endpoint usage for load balancers, and a note on pointing the API at Stellar mainnet versus testnet.

Acceptance Criteria: docs/deployment.md covers at minimum three deployment options with step-by-step instructions. Includes production environment variable recommendations. Covers mainnet vs testnet configuration. Health check endpoint usage is documented. Linked from the README.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationtrivialSmall change, low complexity

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