Getting Started with AlgoKit

Hello, Developer! Welcome to Algorand!

This quick start guide will help you set up your development environment, create your first Algorand project with AlgoKit, and deploy your first Algorand smart contract. By the end of this guide, you’ll be ready to build your own decentralized application on the Algorand blockchain.

But first, what is AlgoKit?

AlgoKit is a simple, one-stop tool for developers to quickly and easily build and launch secure, automated, production-ready decentralized applications on the Algorand protocol — now also featuring native support for Python! This empowers developers to write Algorand apps in regular Python, one of the world’s most popular programming languages.

In addition, AlgoKit features:

• A library of smart contract templates to kickstart your build
• All necessary application infrastructure running locally
• Toolchain integrations for languages you love, like Python and TypeScript
• A simplified frontend design experience

Learn more about AlgoKit Here:

AlgoKit Intro to AlgoKit

Prerequisites

Before you install AlgoKit, you need to install the following prerequisites:

• Python 3.12 or higher
• PipX
• Git
• Docker
• VSCode (recommended)

Install AlgoKit

OS Agnostic

1. To install AlgoKit, run the following command from a terminal.

   pipx install algokit

2. If you used AlgoKit before, update it with pipx:

   pipx upgrade algokit

3. After the installation completes, restart the terminal.

Windows

Note

This method will install the most recent python3 version via winget. If you already have Python 3.12+ installed, you may prefer to use pipx install algokit as explained within the pipx on any OS section so you can control the Python version used.

1. Ensure prerequisites are installed

   • Git (or winget install git.git)
   • Docker (or winget install docker.dockerdesktop)

   Tip

   See our LocalNet documentation for more tips on installing Docker on Windows

2. Install Python3 using WinGet

   • Install python 3.12:

   winget install python.python.3.12

3. Restart the terminal to ensure Python and pip are available on the path

4. Install pipx:

   pip install --user pipx
   python -m pipx ensurepath

5. Restart the terminal to ensure pipx is available on the path

6. Install AlgoKit via pipx:

   pipx install algokit

7. If you used AlgoKit before, update it with pipx:

   pipx upgrade algokit

8. Restart the terminal to ensure AlgoKit is available on the path

macOS

Note

This method will install the latest Python3 release as a dependency via Homebrew. If you already have Python 3.10+ installed, you may prefer to use pipx install algokit as explained within the OS agnostic tab so you can control the Python version used.

1. Ensure prerequisites are installed

   • Homebrew
   • Git (should already be available if brew is installed)
   • Docker, (or brew install --cask docker)

   Tip

   Docker requires MacOS 11+

2. Install using Homebrew

   brew install algorandfoundation/tap/algokit

3. Restart the terminal to ensure AlgoKit is available on the path

Linux

1. Ensure prerequisites are installed

   • Python 3.12+
   • pipx
   • Git
   • Docker

2. Install AlgoKit, with pipx by running the following command from a terminal.

   pipx install algokit

3. If you used AlgoKit before, update it with pipx:

   pipx upgrade algokit

4. After the installation completes, restart the terminal.

Verify the Installation

To verify AlgoKit Installed correctly run the following command:

algokit --version

Output similar to the following should be displayed:

algokit, version 2.6.0

Start a LocalNet

When building smart contracts, it is recommended to build and test on a local Algorand blockchain running on your computer first. Deploying and calling smart contracts on mainnet (the live public blockchain for production) costs real money. Deploying on testnet (a replica of mainnet for testing) can be cumbersome. Therefore, it is recommended to first test on the local blockchain. Once everything works, move to testnet for final testing, and then deploy to mainnet to launch your application.

AlgoKit supports using a local version of the Algorand blockchain. To start an instance of this LocalNet first open Docker Desktop on your computer and then run the following command from the terminal:

algokit localnet start

This should start an instance of the LocalNet within docker. If you open the Docker Desktop application you should something similar to the following:

Create an AlgoKit project

Now, let’s create an Algorand project with AlgoKit. We will refer to these projects as “AlgoKit projects.” AlgoKit provides a series of templates for you to use depending on the type of project you want to create.

This guide will walk you through using either the TypeScript or Python smart contract starter template. Choose the language that you are most comfortable with.

TypeScript

For this guide, we will use the TypeScript smart contract starter template.

1. To create a new AlgoKit project you can easily do so by running:

   algokit init

   This will launch a guided menu system to create a specific project tailored to your needs. You will first be prompted to select the type of project you want to create. For this quick start guide, we will use the TypeScript smart contract template, so select the Smart Contracts option.

   

   AlgoKit Init: Select project template

2. Next, AlgoKit will ask you what programming language you want to use for the smart contract. With AlgoKit 3.0, you can now write Algorand smart contracts with native TypeScript. Let’s select TypeScript as our smart contract language by pressing enter.

   

   AlgoKit Init: Select smart contract language

3. Then AlgoKit will ask you for the name of the project. Let’s name it hello-algorand, but if you want to name it differently, feel free to do so! After writing the name, press enter to continue.

   

   AlgoKit Init: Specifying folder name

4. Next you can set the name of the smart contract. We will keep it as it is for now.

   

   AlgoKit Init : Naming the smart contract app

5. Next, you can select the template preset. The Starter preset is for quickly implementing and testing certain features whereas the Production preset is for production-ready applications. For this guide, let’s select Starter.

   

   AlgoKit Init: Select template preset

6. Next, AlgoKit will ask you if you want to run the algokit project bootstrap command to install the necessary dependencies. Say yes by pressing “y” This process can take a few minutes.

   

   AlgoKit Init: Running the bootstrap command

7. Finally, AlgoKit will ask you if you want to initialize a git repository. Let’s say yes by pressing “y” so that we can easily push our AlgoKit project to Github.

   

   AlgoKit Init: Initialize git repository

8. Once finished, VS Code should automatically be opened with the initialized project if VS Code is set as your default editor. If not, cd into the project directory and open the project in your IDE of choice.

9. This starter app contains one smart contract written in Algorand TypeScript named HelloWorld in the smart_contracts/hello_world/contract.algo.ts file. The contract has a method called hello that takes in a String and returns a String.

   

   AlgoKit Starter Contract

Python

For this guide, we will use the Python smart contract starter template.

1. To create a new AlgoKit project you can easily do so by running:

   algokit init

   This will launch a guided menu system to create a specific project tailored to your needs. You will first be prompted to select the type of project you want to create. For this quick start guide, we will use the Python smart contract template, so select the Smart Contracts option.

   

   AlgoKit Init: Select project template

2. Next, AlgoKit will ask you what programming language you want to use for the smart contract. With AlgoKit 2.0, you can now write Algorand smart contracts with native Python. Let’s select Python as our smart contract language by pressing enter.

   

   AlgoKit Init: Select smart contract language

3. Then AlgoKit will ask you for the name of the project. Let’s name it hello-algorand, but if you want to name it differently, feel free to do so! After writing the name, press enter to continue.

   

   AlgoKit Init: Specifying folder name

4. Next you can set the name of the smart contract. We will keep it as it is for now.

   

   AlgoKit Init : Naming the smart contract app

5. Next, you can select the template preset. The Starter preset is for quickly implementing and testing certain features whereas the Production preset is for production-ready applications. For this guide, let’s select Starter.

   

   AlgoKit Init: Select template preset

6. Next, AlgoKit will ask you what language you want to use for contract deployment. After writing your smart contract you need to deploy and call the contract either from your frontend or backend. Since most frontend frameworks are in Python, let’s select Python for this guide.

   

   AlgoKit Init: Selecting language for contract deployment script

7. Next, AlgoKit will ask you if you want to run the algokit project bootstrap command to install the necessary dependencies. Say yes by pressing “y” This process can take a few minutes.

   

   AlgoKit Init: Running the bootstrap command

8. Finally, AlgoKit will ask you if you want to initialize a git repository. Let’s say yes by pressing “y” so that we can easily push our AlgoKit project to Github.

   

   AlgoKit Init: Initialize git repository

9. Once finished, VS Code should automatically be opened with the initialized project if VS Code is set as your default editor. If not, cd into the project directory and open the project in your IDE of choice.

10. This starter app contains one smart contract written in Algorand Python named HelloWorld in the smart_contracts/hello_world/contract.py file. The contract has a method called hello that takes in a String and returns a String.

    

    AlgoKit Starter Contract

Run the Demo Application

TypeScript

Once the starter project is created, you will notice in the smart_contracts/hello_world folder a file named deploy_config.ts which is a simple example of using AlgoKit to deploy the HelloWorld smart contract in contract.algo.ts on the Local Algorand blockchain started earlier and then call the hello method.

Now there are two ways to run the deploy-config.ts file to deploy and call the smart contract:

1. By hitting F5 it will start LocalNet, build the smart contract, deploy and call the smart contract contract.algo.ts by running the deploy-config.ts file.

2. Alternatively, you can run the following commands from the terminal to build the contract and run the deploy-config.ts file:

   algokit project run build
   algokit project deploy

The output should look similar to the following:

=== Deploying HelloWorld ===
Idempotently deploying app "HelloWorld" from creator RQGFSWXL2RKDBO53MN3ZRWCO3CP2HCZ6T4D5DMNJSIXRV76XAEBUJNHOMY using 86 bytes of AVM bytecode and 4 bytes of AVM bytecode
App HelloWorld not found in apps created by RQGFSWXL2RKDBO53MN3ZRWCO3CP2HCZ6T4D5DMNJSIXRV76XAEBUJNHOMY; deploying app with version 1.0.
App created by RQGFSWXL2RKDBO53MN3ZRWCO3CP2HCZ6T4D5DMNJSIXRV76XAEBUJNHOMY with ID 2225 via transaction PSO2XD77YINZRSNH5X76EN6QZYC2I3P6NITJQCCSDS7IC2PJ4RYA
Sending 1000000 µALGO from RQGFSWXL2RKDBO53MN3ZRWCO3CP2HCZ6T4D5DMNJSIXRV76XAEBUJNHOMY to JM7DKIZGR3M4EGZYYR7LXUDX3R7X6QLRV4S2YVLTSDZP73XLX5A6ZDAQLE via transaction T66O4VNOD5CV6RZ75J53PHFMIIX2DCGT2Q3VM7W3W4CJ7DJQK6MA
App 2225 called with hello(world) by RQGFSWXL2RKDBO53MN3ZRWCO3CP2HCZ6T4D5DMNJSIXRV76XAEBUJNHOMY via transaction W2ZQYBEAFXDKHWDBBKJ6WC56ASAQ267ZEHYESWYLZP3YT3AACMGQ
Called hello on HelloWorld (2225) with name = world, received: Hello, world

The App ID of of the deployed contract and its Algorand address is displayed, followed by the message returned from the smart contract call.

Additionally, by building the smart contract, AlgoKit generates various artifacts in the artifacts folder. These artifacts include:

• Native TEAL smart contract code: HelloWorld.approval.teal, HelloWorld.clear.teal
• Contract ABI: HelloWorld.arc56.json
• Auto-generated typed application client: HelloWorldClient.ts

AlgoKit Starter Artifacts

These artifacts can be used by tools like Lora and goal to deploy your smart contract to various Algorand networks.

Python

Once the starter project is created, you will notice in the smart_contracts/hello_world folder a file named deploy_config.py which is a simple example of using AlgoKit to deploy the HelloWorld smart contract in contract.py on the Local Algorand blockchain started earlier and then call the hello method.

AlgoKit Starter config

Now there are two ways to run the deploy-config.py file to deploy and call the smart contract:

1. By hitting F5 it will start LocalNet, build the smart contract, deploy and call the smart contract contract.py by running the deploy-config.py file.

2. Alternatively, you can run the following commands from the terminal to build the contract and run the deploy-config.py file:

   algokit project run build
   algokit project deploy

The output should look similar to the following:

Deploying hello_world
Called hello on HelloWorld (2225) with name=world, received: Hello, world

The App ID of of the deployed contract is displayed, followed by the message returned from the smart contract call.

Additionally, by building the smart contract, AlgoKit generates various artifacts in the artifacts folder. These artifacts include:

• Native TEAL smart contract code: HelloWorld.approval.teal, HelloWorld.clear.teal
• Contract ABI: HelloWorld.arc56.json
• Auto-generated typed application client: hello_world_client.py

AlgoKit Starter Artifacts

These artifacts can be used by tools like Lora and goal to deploy your smart contract to various Algorand networks.

Using Lora

Try Lora Here! Web-based user interface for visualizing accounts, transactions, assets and applications on an Algorand network and also provides ability to deploy and call smart contracts.

Lora is a web-based user interface that let’s you visualize accounts, transactions, assets and applications on an Algorand network and also provides ability to deploy and call smart contracts. This works for TestNet, MainNet and also LocalNet. While AlgoKit surfaces both a programming interface and a command line interface for interacting with Algorand, it also allows you to quickly open Lora so you can see what’s happening visually.

Lora can be launched from AlgoKit by running the following command from the terminal.

algokit explore

By default it will open Lora and point to LocalNet (It will be displayed as LocalNet in the upper right hand corner), but you can pass in parameters to point it to TestNet and MainNet too.

This command will launch your default web browser and load the Lora web application.

Note

If you are using Safari, then it won’t work against LocalNet and you will need to open it in a different browser.

Lora the Explorer

Create / Connect local account for testing

To issue commands against the LocalNet network you need an account with ALGO in it. Lora gives you three options for connecting to a local wallet: Connect KMD, Connect MNEMONIC, and Connect Lute

• Connect KMD: Lora will automatically import KMD wallet.

• Connect MNEMONIC: You can manually input a MNEMONIC for an account you own.

• Connect Lute: You can create local accounts from Lute and connect to them.

In this guide, we will use the KMD wallet.

Select Connect wallet located at top right hand side of the webpage and you will be prompted with the three wallet choices. Choose the Connect KMD option. This will prompt you to enter the KMD password. If this is your first time building on Algorand, you do not have a KMD password so leave it blank and click OK. This will connect the KMD account to Lora so you can use that account for signing transactions from the Lora user interface.

Deploy the Hello World application

1. To deploy your smart contract application, select the App Lab menu and click on the Create button.

   

   Lora: App Lab

2. Click Deploy new and Select an ARC-32 JSON app spec file to browse to the artifacts created in the previous section of this guide. Select the HelloWorld.arc32.json manifest file.

   

   Lora: Deploying your app

   

   Lora: ARC-32/ARC-56 App Spec

   

   Lora: Uploading generated app spec

3. This will load the specific manifest file for the Hello World sample application. Click Next.

   

   Lora: App spec uploaded successfully

4. You can change the Name and the Version of your app. We will keep it as it is. Click Next.

   

   Lora: Specify app name and version

5. Click the () Call button. Then build and add the create transaction by clicking Add.

   

   Lora: Transaction builder

   

   Lora: Create new transaction

6. Click Deploy and sign the transaction by clicking OK in the KMD pop up to deploy the smart contract to the local Algorand network.

   

   Lora: Transaction created

7. You should now see the deployed HelloWorld contract on the App Lab page.

   

   Lora: Your app is now deployed

8. Now click on the App ID inside of the HelloWorld card to go to the Application page.

   

   Lora: Inspecting your on-chain app

9. Inside the ABI Methods section, you should see the hello method. Click on the drop down and the Call button. You will be prompted with a popup allowing you to enter the parameter for the hello method and call it.

   

   Lora: ABI methods

10. Enter a string in the value input and click on Add.

    

    Lora: Method arguments

11. You should now see the transaction you just built on the Application page. Click Send and sign the transaction with your KMD wallet to execute the transaction.

    

    Lora: Sending the transaction

12. You should now see the Send Result showing you the details about the transaction you just executed!

    

    Lora: Transaction results

13. You can also click on Transaction ID to go to the Transaction page and see the full detail of the transaction.

    

    Lora: Inspect transaction details

You have now successfully deployed and executed a smart contract method call using Lora!

Congratulations and great job completing this guide!

If you have followed this guide, you now have deployed a simple contract to an Algorand network and called it successfully! You are now ready to start building your own decentralized applications on the Algorand blockchain.

Next steps

Learn about general Algorand concepts:

Smart Contracts Dive into Algorand smart contracts, their capabilities and development.

Transactions Explore the different types of transactions on Algorand and how they work.

Learn more about AlgoKit:

Intro to AlgoKit Learn more about AlgoKit and what you can do with it