TBD54566975 / tbd-tutorials

Tutorials and Examples for TBD Projects
Apache License 2.0
4 stars 4 forks source link

Define Runtime Requirements for CLI tools and Scripting #1

Open ALRubinger opened 2 years ago

ALRubinger commented 2 years ago

Some of our examples are best run through simple HTTP requests upon a service. Command-line tools like curl are platform-dependent. And we need to do some light logic for the examples to be automatically-runnable.

For instance, in Frank's first example, we call upon the SSI Service to create a schema for an email address. We then need to extract the ID of this newly-created schema from the JSON response, and use that in the next request to issue a VC. IMO that'd be kind of an ugly job in bash or zsh scripts, and wouldn't be portable across OS's.

Some questions to ponder in this issue:

Leaving this open-ended now - curious for thoughts. I'll think on it too; this is the first thing that occurred to me as I was brainstorming ways to automate Frank's example.

saeedjabbar commented 2 years ago

I think most developers can handle this step regardless of platform and it may be even useful for learning the flow. Frank's tutorial was super easy to follow and took me under 5 minutes to setup. A repo can be setup on replit or codesandbox that is more out of the box.

ALRubinger commented 2 years ago

I think most developers can handle this step regardless of platform and it may be even useful for learning the flow.

Frank's tutorial was super easy to follow and took me under 5 minutes to setup. A repo can be setup on replit or codesandbox that is more out of the box.

Definitely!

I'd like these to be testable, to protect the user experience in the case things change or break. And to test it -- it's gotta be able to be automated, even if the published version at the end of the build looks very similar to Frank's post. 🤘🏻

saeedjabbar commented 2 years ago

@ALRubinger that would be ideal! Creating a launch binary script could be a work around for now.