eclipse-thingweb / eclipse-thingweb/node-wot
Improve set of examples and example scripts (and keep them up-to-date)
- Dominant language
- TypeScript
- Stars
- 192
- Forks
- 100
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 6
Description
At the moment examples and example JS scripts are spread over the various bindings and `/examples` folders. Moreover, some examples tend to get out-of-sync due to API changes.
I think it would be beneficial to have a *single* place where people getting started can look at to find suitable examples.
Another downside of JavaScript examples is that there is no *check* that a given example is still valid (i.e., API changes et cetera). Hence, I propose we create a `thingweb.node-wot/packages/examples/` folder with basic examples and maybe some more sophisticated examples in nested subfolders for each binding. The examples should use TypeScript which gives us more ways to check whether a script is still valid (syntax-wise). The TS file could still be transcompiled to JS but the starting point should be always TS.
Any thoughts/opinions?
Other proposals?
Contributor guide
Assessment
This issue has not been assessed yet.