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

feat: Add a StackBlitz tutorial for creating and using a session #80

Open
joepegler opened this issue Oct 25, 2024 · 0 comments
Open

feat: Add a StackBlitz tutorial for creating and using a session #80

joepegler opened this issue Oct 25, 2024 · 0 comments
Assignees
Labels

Comments

@joepegler
Copy link
Collaborator

What

Create an interactive StackBlitz tutorial that demonstrates the process of creating and using a session with the Smart Sessions Module.

Why

  • Provide a hands-on learning experience for developers
  • Allow users to experiment with the Smart Sessions Module without needing funds in their wallet
  • Enhance documentation with a practical, runnable example
  • Improve user engagement and understanding of the Smart Sessions concept

How

  1. Develop a StackBlitz project that walks through the following steps:

    • Setting up the Nexus client
    • Creating a Smart Sessions Module
    • Installing the module
    • Creating a Smart Session
    • Using the Smart Session to perform an action
  2. Ensure the tutorial can run without requiring users to have funds in their wallet:

    • Use a pre-funded test account or implement a faucet mechanism
    • Provide clear instructions on how to use the pre-funded account
  3. Structure the tutorial to be runnable from an iframe, similar to the viem example:

    • Set up the project to work within StackBlitz's environment
    • Ensure all dependencies are properly configured
  4. Integrate the StackBlitz tutorial into the existing documentation:

    • Add an embedded iframe to display the live example
    • Include a "Run Project" button that opens the tutorial in StackBlitz
  5. Write clear, step-by-step instructions within the StackBlitz project:

    • Explain each part of the code and its purpose
    • Use comments to guide users through the process
  6. Test the tutorial thoroughly to ensure it works as expected in both the iframe and full StackBlitz environment

  7. Update the documentation page to reference and explain the new interactive tutorial

  8. Consider adding challenges or exercises at the end of the tutorial to reinforce learning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants