feat(devex): add a node quickstart example using the typescript sdk - #313
Merged
Conversation
Add examples/node-quickstart, a runnable Node script that lists and fetches ledger accounts through the TypeScript SDK, so adopters have a working starting point. It reads the base URL and bearer token from the environment and depends on the local SDK package, with a dedicated workflow that builds the SDK and typechecks the example. No token is embedded and nothing is published. Closes #306
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
E-09 DevEx #306 (F-09.7) - the examples directory, starting with one runnable quickstart.
What
examples/node-quickstart/ - a Node + TypeScript script that dogfoods the new @fincore/sdk-typescript (#305) via a file: dep:
This makes the SDK's value concrete and keeps the SDK honest (a real consumer compiles against it). More runtimes/examples are a natural follow-up.
Evidence (node v24 local)
Built the SDK, then example npm install (resolves the file: dep) + typecheck + build all green.
Gate chain
Two LOW advisories declined with reason (node 22 matches the web-ci/sdk-ts-ci convention; npm install vs ci is intentional for the file:-linked dep).
Closes #306