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

Add more interactive examples to the website #13

Open
mkrl opened this issue Oct 14, 2021 · 3 comments
Open

Add more interactive examples to the website #13

mkrl opened this issue Oct 14, 2021 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mkrl
Copy link
Owner

mkrl commented Oct 14, 2021

Is your feature request related to a problem? Please describe.

The website itself is pretty boring for now. There's so much you can do with the power of ttty!

Describe the solution you'd like

I think it would be great to add one or more of the following:

  1. More commands to the demo website (fetching a Chuck Norris joke? Downloading kitten pictures? Rickrolling?)
  2. Ideally every new command should demonstrate or teach an interesting use case as an example (multiple arguments, adding more terminals, working with the existing terminal instance, etc.)
  3. Something else that's cool and engaging.

Additional context

You can use a pre-existing system for "clickable" feature list in the index.html (based on data-exec attributes).

@mkrl mkrl added enhancement New feature or request good first issue Good for newcomers hacktoberfest For all the Hacktoberfest participants! labels Oct 14, 2021
@runningdeveloper
Copy link
Contributor

Hi can I add an example to fetch a Github profile picture and public repos from the username?
It could be something like github username then it returns an image and the amount of public repos the username has.

This will show doing a simple GET request and that you can print out raw html (for the image). They have a public users api with basic info like - https://api.github.com/users/runningdeveloper

@mkrl
Copy link
Owner Author

mkrl commented Oct 17, 2021

@runningdeveloper that's a great idea! I would say displaying an image in the terminal would kind of go "against the terminal principles" (even though it is technically possible), but you can fetch some other useful info. Other than that, that sounds great.
You can use the start/stop to prevent user interaction until the GET request resolves.

@runningdeveloper
Copy link
Contributor

Ok thanks @mkrl I agree with you and will only display some text. I'll do a pull request this week and you can let me know what you think.

@mkrl mkrl removed the hacktoberfest For all the Hacktoberfest participants! label Jan 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants