Skip to content
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.

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

Improve set of examples and example scripts (and keep them up-to-date) #171

Open
danielpeintner opened this issue Feb 19, 2020 · 1 comment
Labels
enhancement New feature or request examples Issues related examples in the repository

Comments

@danielpeintner
Copy link
Member

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?

@egekorkan
Copy link
Member

+1 from my side. The exposed thing template would be a good starting point for converting them into Typescript.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request examples Issues related examples in the repository
Projects
None yet
Development

No branches or pull requests

3 participants