This repository is a template for creating new AlgoKit projects. It includes a basic structure for creating a full-stack project.
poetry install
- Install the dependencies for the project.
pipx install algokit
- Ensure cli is installed.
Ensure localnet is running by executing algokit localnet reset
.
poetry run pytest -n auto
This will regenerate the tests for default starter
and production
presets available on the template.
algokit -v init --name playground --no-git --UNSAFE-SECURITY-accept-template-url --template-url . --template-url-ref HEAD --no-bootstrap
To generate a dummy project into the playground
folder. This is useful for testing the template to quickly preview the output of the template before testing via pytest
.
In VSCode IDE, you can find the tasks in the .vscode/tasks.json
file. To run them:
- Open the command palette (
Cmd+Shift+P
on macOS,Ctrl+Shift+P
on Windows/Linux) and type> Run Task
- Select the task you want to run
- It will be generated for you under the playground folder
To cleanup the playground folder run dedicated cleanup task.
We are using the Conventional Commits standard for commit messages. This allows us to automatically generate release notes and version numbers. We do this via Python Semantic Release and GitHub actions.
AlgoKit development is done within the AlgoKit Guiding Principles.
- Submit a pull request to the
main
branch. Fork the repo if you are an external contributor. - Ensure that the pull request is up to date with the
main
branch. - Ensure that the pull request has a clear title and description.
- Pass PR reviews and wait for approval.