Skip to content

docs: platform support and template README updates (#111 #112 #113 #114) #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dDevAhmed merged 2 commits into from
Oct 18, 2026
Merged

docs: platform support and template README updates (#111 #112 #113 #114) #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41f4c1f
docs: add platform support and template README updates for Maryermarh…
Maryermarh Oct 18, 2026
c78dfee
docs: reconcile platform support, api-service, and smart-contract gui…
Maryermarh Oct 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/platform-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ StellarForge CLI treats supported-platform failures as release blockers unless a
| macOS (GitHub-hosted macOS) | Node.js 22.13+ LTS | Tests and build |
| Windows (GitHub-hosted Windows) | Node.js 22.13+ LTS | Tests and build |

The package engine range remains `Node.js >=22.13.0 <25`. Node.js 22 and Node.js 24 are the supported LTS majors for the current MVP. Intermediate non-LTS Node releases are not release-validation targets.
The package engine range remains `Node.js >=22.13.0 <25` and `npm >=10.9.0`, matching `package.json`. Node.js 22 and Node.js 24 are the supported LTS majors for the current MVP. Intermediate non-LTS Node releases are not release-validation targets. These documented ranges mirror the CI matrix and must not be expanded or contracted without a policy review.

## What the platform matrix exercises

Expand Down
2 changes: 1 addition & 1 deletion templates/api-service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Minimal StellarForge API service starter for backend services that need clear St

- Node.js 22.13 or newer

The starter has no runtime dependencies. It uses Node's built-in HTTP server and test runner.
The starter has no runtime dependencies. It uses Node's built-in HTTP server and test runner, so there is no separate install step; `npm start`, `npm run check`, and `npm test` run directly. On Windows, copy the example file with `copy .env.example .env`.

## Start

Expand Down
4 changes: 4 additions & 0 deletions templates/basic-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ npm run check
npm test
```

## Notes

This template is intended as a minimal starting point for Stellar dApps. For production deployments, configure your own RPC and Horizon endpoints and secure any signing keys appropriately.

## Network configuration

The starter defaults to Stellar Testnet:
Expand Down
2 changes: 2 additions & 0 deletions templates/smart-contract/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,5 @@ stellar contract invoke \
```

Do not commit private keys, secret seeds, signing credentials, or production deployment material. Use locally managed Stellar identities or your approved secret-management workflow.

This starter targets Stellar Testnet only; it does not configure or claim Mainnet or hosted deployment support.