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

README.md refers to non-existant algokit command #317

Closed
HashMapsData2Value opened this issue Sep 28, 2023 · 1 comment
Closed

README.md refers to non-existant algokit command #317

HashMapsData2Value opened this issue Sep 28, 2023 · 1 comment
Labels
question Further information is requested

Comments

@HashMapsData2Value
Copy link

HashMapsData2Value commented Sep 28, 2023

image

The README.md that gets generated under project/backend/smart_contracts instructs that you should run algokit generate smart-contract at the root of the repository. However, there is no algokit generate smart-contract command, only algokit generate client.

image

@aorumbayev
Copy link
Collaborator

Hello @HashMapsData2Value thanks for reporting, i believe this is a non-issue.

Please refer to using-custom-generate-commands documentation to read more about how exactly generate works when dealing with custom generators (smart-contracts in your case). I see that you have an .algokit folder in your template, this is actually the custom generator that comes bundles with the beaker template and when you run algokit generate from the root of the backend folder (the same level that contains algokit.toml file) then this custom smart-contract generator command is injected into algokit dynamically. You can also inspect algokit.toml to see how exactly it references the custom generator.

So I suspect the issue is due to the fact that you may be running this command from the wrong folder, keep in mind if this is within a fullstack template then backend and frontend folders are completely independent so READMEs inside those folders refer exclusively to their own scope.

Please confirm the version of algokit you are using and try re running the generate from the root of the backend folder.

Lastly, if you are interested in creating your own custom generators (which are essentially, mini jinja templates that allow you to customize a lot of options in regards to any file manipulation you might need in your algokit project, you can also execute custom scripts in any language for pre or post processing) -> https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/algokit-template.md#working-with-generators.

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

No branches or pull requests

3 participants