This template provides a good starting point to build Beaker smart contracts productively.
This is the default template used by AlgoKit to initialise an Algorand smart contract project. It's a Copier template.
This template supports the following features:
- Poetry for Python dependency management and virtual environment management
- Linting via Ruff or Flake8
- Formatting via Black
- Type checking via mypy
- Testing via pytest (not yet used)
- Dependency vulnerability scanning via pip-audit (not yet used)
- VS Code configuration (linting, formatting, breakpoint debugging)
- dotenv (.env) file for configuration (not yet used)
Planned (future) features:
- Deployment and automated testing of the compiled smart contracts using TypeScript or Python
- Output stability tests of the teal output via pytest
- CI/CD pipeline using GitHub actions
Once the template is instantiated you can follow the README.md file to see instructions for how to use the template.