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

algokit init - Wizard + Template base #62

Closed
robdmoore opened this issue Nov 25, 2022 · 2 comments · Fixed by #77 or #78
Closed

algokit init - Wizard + Template base #62

robdmoore opened this issue Nov 25, 2022 · 2 comments · Fixed by #77 or #78
Assignees
Labels
algokitv1 Original AlgoKit v1 backlog items

Comments

@robdmoore
Copy link
Contributor

robdmoore commented Nov 25, 2022

Acceptance Criteria:

  • Template = repository
  • Allowlist of known, reviewed templates with: repository url, optional commit SHA
  • Wizard options are able to be passed in via cmdline, but if any required options aren't then it will prompt you and receive via stdin
  • You can skip the allowlist and pass in a repository url via --template-url, but it will warn you of the security risk and confirm via stdin that you are sure you want to do it
  • algokit init
    • Name of project (--name, -n)
      • The template is initialised in a sub-folder of this name
      • Validation: /^[\w-.]+$/ and the directory doesn't exist already
    • Template (default: beaker-default) (--template, -t)
      • Validation: ID from allowlist
      • Have a link to the documentation for the templates
      • Nice to have: Scrolling list like create-remix template selection
    • Deployment language: TypeScript | Python (will be added in later story, --deployment-lang, -l, default: Python)
    • Install dependencies: y/n
      • If Y/y then install the Python dependencies
  • Once the template is there output the commands to open the folder and open their IDE and a URL to the next steps documentation
@achidlow achidlow self-assigned this Dec 1, 2022
@achidlow
Copy link
Contributor

achidlow commented Dec 1, 2022

Once the template is there output the commands to open the folder and open their IDE

This seems a bit complex? How do we know if they're using code or code-insiders or pycharm (and that only works if they have bin scripts setup) or even idea (same issue)?

a URL to the next steps documentation

Next steps could depend on the template - maybe it's better to include those in the templates themselves?

@robdmoore
Copy link
Contributor Author

Yeah the initial thinking was we don’t specify the ide command just literally the text “open in your IDE”.

eventually we may ask them what IDE(s) they want to use

This was linked to pull requests Dec 12, 2022
@robdmoore robdmoore reopened this Jan 4, 2023
@robdmoore robdmoore added the algokitv1 Original AlgoKit v1 backlog items label Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
algokitv1 Original AlgoKit v1 backlog items
Projects
None yet
2 participants