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 option to scaffold web-app from a configuration file (that can be autogenerated) #392

Open
c12i opened this issue Aug 7, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@c12i
Copy link
Collaborator

c12i commented Aug 7, 2024

Scaffolding Replay Feature

  • As a user I would like to be able to re-run previously run commands without going through the same prompts.

Solutions

  • Log each command and inputs run via the scaffolding cli into a logfile/ script file, which will generally be ignored from version control.
  • The user can use this previously generated file to scaffold a new app i.e feeding it into the scaffolding cli as input

Technical Details

  • Capture each command and inputs for each command / propmt
    • Can be written into a yaml file
web-app:
    name: "my-app"
    description: "my description"
    holo: true
    disable-fast-track: false
    setup-nix: true
    package-manager: npm | pnpm | yarn | bun
dna:
    app: "my_app"
    name: "my_dna"
zome:
    coordinator: <path>
    integrity: <path>
    dna: "my_app"
    name: "my_zome"
entry-type:
    crud: "crud"
   # updatable: true
   # deletable: true
    fields:
        - name: "name"
          type: "String"
          widget: "TextField"
          linked_from:
    link-from-original-to-each-update: true
    reference-entry-hash: false
    zome: "my_zome"
    no-ui: false
link-type:
    from-referenceable: "EntryA"
    to-referenceable: "EntryB"
    zome: "my_zome"
    dna: "my_dna"
    bidirectional: true
    delete: true
    no-ui: false
  • The config file should follow the schema above, the example and template commands are left out since they are non project editing

    • This can change in the future, for now, let's get this to work with the vanilla workflow
  • Create structs for scaffoldable items and have a method to yamlfy the struct, then write it to a scaffold-log.yaml file

  • Create a command to scaffold from a config yaml file.

@c12i c12i self-assigned this Aug 7, 2024
@c12i c12i transferred this issue from holochain/Components Oct 15, 2024
@c12i c12i added this to Holochain Oct 15, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Holochain Oct 15, 2024
@c12i c12i changed the title Add option to scaffold web-app from a configuration file feat: Add option to scaffold web-app from a configuration file Oct 15, 2024
@c12i c12i mentioned this issue Oct 15, 2024
@c12i c12i moved this from Backlog to Ready for refinement in Holochain Oct 15, 2024
@c12i c12i moved this from Ready for refinement to Backlog in Holochain Oct 15, 2024
@c12i c12i added the enhancement New feature or request label Oct 15, 2024
@c12i c12i moved this from Backlog to Ready in Holochain Oct 22, 2024
@c12i c12i moved this from Ready to Ready for refinement in Holochain Oct 22, 2024
@c12i c12i moved this from Ready for refinement to Ready in Holochain Oct 22, 2024
@c12i c12i moved this from Ready to Backlog in Holochain Oct 22, 2024
@c12i c12i moved this from Backlog to Awaiting clarification in Holochain Nov 5, 2024
@Zequez
Copy link

Zequez commented Nov 10, 2024

The post you linked requires some sort of permission to read it, even signing up for Hackmd.io still throws error 403. Do you have an alternative link?

@c12i
Copy link
Collaborator Author

c12i commented Nov 11, 2024

Yes it does @Zequez, will move over the content here, thanks for the heads up

@c12i c12i changed the title feat: Add option to scaffold web-app from a configuration file feat: Add option to scaffold web-app from a configuration file (that can be autogenerated) Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Awaiting clarification
Development

No branches or pull requests

2 participants