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: init wizard v2 improvements #19

Merged
merged 48 commits into from
Feb 26, 2024
Merged

feat: init wizard v2 improvements #19

merged 48 commits into from
Feb 26, 2024

Conversation

aorumbayev
Copy link
Contributor

@aorumbayev aorumbayev commented Feb 21, 2024

Proposed Changes

  • Refining presets, adding notion of a custom preset
  • Reusing algokit-base-template for workspace specific artifacts - to remove coupling and redundancy
  • Renaming templates_generated to more generic examples folder that by default tests the main 'starter' and 'production' presets
  • Adding Contribution guide and simple starting point for generating dummy instances of templates for quick preview during development
  • Removing dependency on beaker, instead allows specifying all main frameworks to pair against default react component
  • Refining codespaces setup for vscode for puya, beaker. Tealscript is currently not supporting the full e2e launch config flow hence template will only supply base codespaces file for aggregate folder preview (no custom launch configs).
  • Fixing visitors badge
  • Base template at the workspace level (see step 1 in _tasks in copier.yaml at the root) - also drops a devcontainer artifact for github codespaces (similar behaviour for all standalone templates too). Making it easy to quickly load up any workspace typed algokit project to a dev environment from their github repo. A feature heavily utilized by DevRels during various bootcamp activities, given existing feedback and feature requests as part of the wizard adr and small footprint i think its a fair point to keep devcontainers at the base template level.
  • TEMPORARY - changing pipx install algokit to version from wizard v2 branch
  • TEMPORARY - ci is to be fixed as soon as base template repo becomes public -> done

@aorumbayev
Copy link
Contributor Author

@neilcampbell for simpler review, ignore changes in tests_generated the main gist is in template_content and copier.yaml, and examples could probably checked last.

I could rename examples back to tests_generated folder but given the presets being changed to hide all questions by default, there would have been a lot of artifacts in diff regardless since number of default scenarios is now reduced to just 2 options. The workspace structure would cause changes within each artifact as well so renaming to examples is marginally similar in size. As for why its set to examples, see a note in README.md that mentions that this folder can be used for quick preview of sample pre-made projects.

@aorumbayev aorumbayev marked this pull request as ready for review February 21, 2024 14:19
.github/workflows/check-python.yaml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
template_content/inject_content/README.md Outdated Show resolved Hide resolved
template_content/inject_content/README.md Outdated Show resolved Hide resolved
template_content/inject_content/README.md Outdated Show resolved Hide resolved
template_content/inject_content/README.md Outdated Show resolved Hide resolved
@aorumbayev
Copy link
Contributor Author

@neilcampbell feel free to unresolve any of the above but should be now addressed. Will check out the comments on react

@aorumbayev aorumbayev merged commit 2ccd4cc into main Feb 26, 2024
1 check passed
@aorumbayev aorumbayev deleted the poc/wizard_v2 branch February 26, 2024 14:58
@aorumbayev aorumbayev restored the poc/wizard_v2 branch February 26, 2024 16:10
@aorumbayev aorumbayev deleted the poc/wizard_v2 branch March 6, 2024 19:22
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

Successfully merging this pull request may close these issues.

2 participants