Skip to content
This repository has been archived by the owner on Nov 27, 2024. It is now read-only.

algorandfoundation/algokit-beaker-default-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

aa3624a · Apr 25, 2023

History

86 Commits
Apr 21, 2023
Apr 4, 2023
Apr 21, 2023
Apr 19, 2023
Apr 21, 2023
Dec 6, 2022
Mar 28, 2023
Mar 28, 2023
Apr 25, 2023
Apr 4, 2023
Apr 19, 2023
Apr 4, 2023
Apr 19, 2023

Repository files navigation

AlgoKit Beaker Template

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.

Features

This template supports the following features:

  • Compilation of multiple Beaker contracts to a predictable folder location and file layout where they can be deployed
  • Deploy-time immutability and permanence control
  • 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

Planned (future) features:

  • 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

Getting started

Once the template is instantiated you can follow the README.md file to see instructions for how to use the template.