Skip to content

Commit

Permalink
docs: Fixing heading order in intro tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
robdmoore authored and daniel-makerx committed Mar 29, 2023
1 parent 815712f commit 46b5023
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/tutorials/intro.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
AlgoKit Quick Start Tutorial
# AlgoKit Quick Start Tutorial

AlgoKit is the primary tool used by the Algorand community to develop smart contracts on the Algorand blockchain. It provides the capabilities to develop, test and deploy Algorand smart contracts within minutes! This guide is intended to help you setup AlgoKit and to start developing your application.

# Quick start videos
## Quick start videos

If you prefer videos, take a look at this 10 minute guide to getting started.

[![Learn How to Build on Algorand in 10 Minutes](../imgs/algokit-intro-video-thumbnail.jpg)](https://www.youtube.com/embed/dow6U8DxOGc)

Detailed video guides for both [Windows](https://www.youtube.com/embed/22RvINnZsRo) and [Mac](https://www.youtube.com/embed/zsurtpCGmgE) are also available.

# Prequisites
## Prequisites

This guide presents installing AlgoKit using an OS agnostic procedure. For OS specific instructions take a look that the [AlgoKit install](https://github.com/algorandfoundation/algokit-cli/blob/main/README.md#install) guide.

Expand All @@ -22,7 +22,7 @@ Using this procedure requires the the following components be installed already
- [Docker](https://docs.docker.com/desktop/install/mac-install/)
- [VSCode](https://code.visualstudio.com/download)

# Install AlgoKit
## Install AlgoKit

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

Expand All @@ -34,7 +34,7 @@ After the installation completes, **restart the terminal**.

For more detailed installation documentation, see the [official installation guide](https://github.com/algorandfoundation/algokit-cli#install).

# Verify the Installation
## Verify the Installation

To verify AlgoKit Installed correctly run the following.

Expand All @@ -48,7 +48,7 @@ Output similar to the following should be displayed:
algokit, version 0.5.0
```

# Start a LocalNet
## Start a LocalNet

AlgoKit supports using a [local version of the Algorand blockchain](../features/localnet.md). To start an instance of this LocalNet run the following command from the terminal:

Expand All @@ -60,7 +60,7 @@ This should start an instance of the LocalNet within docker. If you open the Doc

![Docker Desktop LocalNet Instance](../imgs/localnet.png)

# Create an AlgoKit project
## Create an AlgoKit project

Now that AlgoKit is installed, you can rapidly create a new project to get started quickly. This can be done by running:

Expand All @@ -76,7 +76,7 @@ Once finished, (if you have it installed) VS Code should automatically be opened

![AlgoKit Playground Contract](../imgs/algokitplayground.png)

# Run the Demo Application
## Run the Demo Application

Once the playground project is created, you will notice in the `hello_world` folder a file named `demo.py` which is a simple example of using AlgoKit to deploy and make a call to the `helloworld.py` smart contract on the LocalNet instance started earlier.

Expand Down Expand Up @@ -110,7 +110,7 @@ Additionally, you can find the native TEAL smart contract code and the appropria

Running the `build.py` python file will also generate these artifacts without deploying. These files can be used by tools like [Dappflow](https://dappflow.org/), [goal](https://developer.algorand.org/docs/clis/goal/goal/), etc. to deploy your smart contract to the various Algorand networks.

# Using Dappflow
## Using Dappflow

Dappflow is a web-based user interface that let's you visualise 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. Furthermore, you can also create and fund accounts on LocalNet. While AlgoKit surfaces both a programming interface and a command line interface for interacting with Algorand, it also allows you to quickly open Dappflow so you can see what's happening visually.

Expand All @@ -128,7 +128,7 @@ This command will launch your default web browser and load the Dappflow web appl

![AlgoKit Dappflow](../imgs/dappflow1.png)

## Create test account
### Create test account

To issue commands against the LocalNet network you need an account with ALGOs in it. Dappflow lets you easily create one.

Expand All @@ -138,7 +138,7 @@ Select `Dev Wallets` from the left menu and click on the `Create wallet` button.

In the bottom left hand corner of the menu, select `Connect wallet` and you will be prompted with several wallet choices. Choose the `Dev Wallet` option. This will connect the account you just created to Dappflow so you can use that account for signing transactions from the Dappflow user interface.

## Deploy the Hello World application
### Deploy the Hello World application

To deploy the built Beaker smart contract application, select the `Beaker studio` menu and click on the import beaker app. Select `File` and `Upload file`, browse to the artifacts created in the previous section of this guide. Select the `application.json` manifest file. This will load the specific manifest file for the Hello World sample application.

Expand All @@ -158,7 +158,7 @@ Enter a string in the parameter and click on `Execute`. You should get get a con

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

# Next steps
## Next steps

- To learn more about AlgoKit and what you can do with it, checkout the [AlgoKit documentation](../algokit.md).
- To learn more about Beaker, take a look at the [Beaker documentation](https://beaker.algo.xyz/).
Expand Down

0 comments on commit 46b5023

Please sign in to comment.