Skip to content

Add project scaffolding  #21

Closed
Closed

Description

Describe the solution you'd like
As a user I'd like to be able to use swa to scaffold a new project structure.

Example: running swa init should produce the following project structure:

├── api
│   └── <azure functions project>
├── app
│   └── <front-end project>
└── swa.json

Other options/questions:

  • add an interactive mode (like in https://hexa.run)?
  • only scaffold the api folder?

Activity

  1. aaronpowell commented on Nov 5, 2020

    @aaronpowell
    Contributor

    Unless it's for setting up the SWA config file (per #20) I feel like the implementation effort would greatly outweigh the user value.

    We have a lot of permutations that we'd need to support, first there's the client framework (React, Vue, Angular, Svelte, Vanilla JS, Blazor), then whether you want an API, and if so, what's the API written in (JS, TypeScript, C#, F#, Python). Then there's static site generators (VuePress, Gatsby, Hugo, Jekyll, Nuxt) that would also be options.

  2. aaronpowell commented on Aug 18, 2021

    @aaronpowell
    Contributor

    Thinking about this - would it be possible to use the GitHub repo templates to generate a project? That would make it easier to have the permutations handled (just create a new template)

  3. manekinekko commented on Aug 18, 2021

    @manekinekko
    MemberAuthor

    I am in favor of this 👍

  4. anthonychu commented on Aug 21, 2021

    @anthonychu
    Member

    We need to think about what problem this addresses. Is the goal to prescribe an opinionated folder structure? GitHub templates might be a good idea but there's a maintenance overhead to them. How many people would find them useful?

    We'll be doing some research studies in the next few months around the CLI. We'll include the getting started experience. /cc Reshmi Sriram (@Reshmi-Sriram)

  5. aaronpowell commented on Aug 23, 2021

    @aaronpowell
    Contributor

    We need to think about what problem this addresses. Is the goal to prescribe an opinionated folder structure? GitHub templates might be a good idea but there's a maintenance overhead to them.

    The goal would be to give people a starting point for creating a project, whether they are experienced with SWA or it's their first time. I think of it in a similar manner to someone using func init to setup the starting point for a Functions app.

  6. aaronpowell commented on Nov 16, 2021

    @aaronpowell
    Contributor

    btw, I created a standalone tool to do this - https://dev.to/azure/scaffolding-static-web-apps-4p97

  7. locked and limited conversation to collaborators on Feb 2, 2022
  8. converted this issue into a discussion #384 on Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions