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

demo maker component #239

Open
39 tasks
Tracked by #9
serapath opened this issue Apr 15, 2022 · 0 comments
Open
39 tasks
Tracked by #9

demo maker component #239

serapath opened this issue Apr 15, 2022 · 0 comments

Comments

@serapath
Copy link
Member

serapath commented Apr 15, 2022

@todo

  • implement first iteration of component
    • create repository
    • set up local dev environment with pnpm
      • pnpm link the modules locally
        • pnpm link --global (to make them available)
        • pnpm link --global <./package.json#name>
    • @outputrepository
  • refactor component latest commit with new comm protocol and tag with v0.0.1.-alpha
    • @inputrepository
    • refactor latest commit with latest terminal/log to use versions
    • refactor communication protocol to use latest message standard
    • move terminal/logs to dev dependencies
    • rebase main branch on top of taged version
    • update package.json (new path for the dependencies)
    • update github page links
    • build new bundle.js to include changes in demo page
  • implement next component version v0.0.2-alpha
    • @inputrepository#v0.0.1.-alpha
    • fix bugs & add features for v0.0.2- [ ] support single select (Support a filter for search swarm key and terminal messages using)
      • make new demo-maker component
        • text box with title, description and execute button
        • container element with the ui component you are demoing
      • Refactor codes(protocol, receive, recipients)
      • refactor all messages and status and update documentation
    • set up github page using demo maker component dev dependency
    • document component api in readme or whatever needs to show in the readme
      • document apis for each screen and return available actions
        • @inputwireframes action bars
    • document component api in readme
      • list all opts
      • list all roles
      • list all incoming message types
      • list all outgoing message types
      • list all possible status the component instance can be in
  • install latest dev dependencies
    • budo
    • browserify
    • datdot-terminal
  • install latest specific version of dependencies
    • ...
  • update github page links
  • build new bundle.js to include changes in demo page
  • update package.json (new path for the dependencies)

@info

the idea is a helper component for demo pages so it shows a component instance and a text field with a code snippet which is used to generate the component instance. A user can now tweak the code snippet based on the component api documentation in the readme and see how it changes the component instance.

Additional features could be to allow the component to be themed and to display multiple instances of the component each with modified code snippet to pass for example different arguments.

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

No branches or pull requests

1 participant