AlgoKit Quick Start Guide

Prerequisites

Before getting started with AlgoKit, ensure you have the following components installed on your system:

Verify Installation

To confirm AlgoKit has been installed correctly, run the following command:

You should see output similar to:

Start a LocalNet

AlgoKit supports running a local version of the Algorand blockchain for development. To start a LocalNet instance:

This command starts a LocalNet instance within Docker. You can verify it's running by opening Docker Desktop:

Create an AlgoKit Project

With AlgoKit installed, you can rapidly create a new project tailored to your needs:

This launches a guided menu system to create a project from various templates. For this guide, select:

Once completed, VS Code will open with the initialized project. The starter app contains one smart contract built with Algorand Python:

Run the Demo Application

In the smart_contracts/hello_world folder, you'll find deploy_config.py, which demonstrates deploying and calling the smart contract:

Press F5 to deploy the HelloWorld smart contract and call it. Alternatively, use these commands:

Expected output:

The artifacts folder will contain the compiled TEAL code and manifest files:

Using Lora

Lora is a web-based interface for visualizing accounts, transactions, assets, and applications on Algorand networks. Launch it with:

This opens Lora in your default browser, connected to LocalNet:

Connect Local Account for Testing

To interact with LocalNet, you need an account with ALGO. Click "Connect Wallet" and choose "Connect KMD":

Deploy via Lora

Navigate to App Lab and click "Create" to deploy your smart contract:

Choose "Deploy new" and select your HelloWorld.arc32.json manifest file:

This will load the specific manifest file for the Hello World sample application. You can modify the Name and Version of your app if needed, but we'll keep the defaults. Click Next:

Build and Deploy Transaction

Click the "Call" button, then build and add the create transaction by clicking "Add":

This opens the Build Transaction dialog where you can configure the deployment parameters:

After configuring the transaction, you'll see it added to the transaction group. Click "Deploy" and sign the transaction by clicking "OK" in the KMD popup to deploy the smart contract to the local Algorand network:

View Deployed Contract

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

Now click on the App ID inside the HelloWorld card to navigate to the Application page:

Call Smart Contract Method

In the ABI Methods section, you should see the "hello" method. Click on the dropdown and the "Call" button. You'll be prompted with a popup allowing you to enter the parameter for the hello method:

Enter a string in the value input field and click "Add":

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:

View Transaction Results

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

You can also click on the Transaction ID to go to the Transaction page and see the full details of the transaction: