WE34ZFE6ZKF4PC7FFNQFOSB7NLC4K6IWVVOGOS5CXMESVMFGUJH6L6WJGQ
469360340
This project has been generated using AlgoKit to help you quickly get started with a basic playground for experimenting with Beaker smart contracts against a LocalNet network.
See below for default getting started instructions.
- Ensure you have AlgoKit installed and run
algokit bootstrap all
in this directory - Open this directory in Visual Studio Code. Make sure you're using python venv.
- Run the build script
python3 playground/realtorteal/build.py
- Start algokit localnet
algokit localnet start
- It will: start LocalNet use
algokit explore
to open the dashboard, use the contract.json and teal files from artifacts folder.
- Clone this repository locally
- Install pre-requisites:
- Install
AlgoKit
- Link: Ensure you can executealgokit --version
. - Bootstrap your local environment; run
algokit bootstrap all
within this folder, which will:- Install
Poetry
- Link: The minimum required version is1.2
. Ensure you can executepoetry -V
and get1.2
+ - Run
poetry install
in the root directory, which will set up a.venv
folder with a Python virtual environment and also install all Python dependencies
- Install
- Install
- Open the project and start debugging / developing via:
- VS Code
- Open the repository root in VS Code
- Install recommended extensions
Note If using Windows: Before running for the first time you will need to select the Python Interpreter.
- Open the command palette (Cmd/Ctrl + Shift + P)
- Search for
Python: Select Interpreter
- Select
./.venv/Scripts/python.exe
- IDEA (e.g. PyCharm)
- Open the repository root in the IDE
- It should automatically detect it's a Poetry project and set up a Python interpreter and virtual environment.
- Hit Shift+F9 (or whatever you have debug mapped to) and it should start running with breakpoint debugging.
- Other
- Open the repository root in your text editor of choice
- In a terminal run
poetry shell
- Run the build script
python3 playground/realtorteal/build.py
through your debugger of choice
- VS Code
- If you update to the latest source code and there are new dependencies you will need to run
algokit bootstrap all
again - Follow step 3 above
The following tools are used in this project:
- Algorand - Layer 1 Blockchain; Developer portal, Why Algorand?
- AlgoKit - One-stop shop tool for developers building on the Algorand network; docs, intro tutorial
- Beaker - Smart contract development framework for PyTeal; docs, examples
- PyTEAL - Python language binding for Algorand smart contracts; docs
- AlgoKit Utils - A set of core Algorand utilities that make it easier to build solutions on Algorand.
- Poetry: Python packaging and dependency management.