Skip to content

Commit

Permalink
Merge pull request #1253 from algorandfoundation/staging
Browse files Browse the repository at this point in the history
staging => master
  • Loading branch information
nullun authored Mar 27, 2024
2 parents 7c6e603 + c53ecf8 commit 1ba1c0a
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/get-started/algokit.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
title: AlgoKit Quick Start Guide

The Algorand AlgoKit CLI is the one-stop shop tool for developers building on the Algorand network. The goal of AlgoKit is to help developers build and launch secure, automated production-ready applications rapidly. AlgoKit contains these components:

- Smart contract templates - kickstart your dApp by selecting from our template library
- Web3 infrastructure - all the network, database, wallet, block explorer and APIs running locally
- Toolchain integrations - for languages you love: Python and Typescript
- React component generation - frontend design simplified using components generated for each contract method call
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

## 10 minute video walkthrough

Expand All @@ -22,8 +22,8 @@ The Algorand AlgoKit CLI is the one-stop shop tool for developers building on th
## Install AlgoKit

=== "Windows"
!!! Note
This method will install the most recent python3 version [via winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/). If you already have python 3.12+ installed, you may 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.
!!! Note
This method will install the most recent python3 version [via winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/). If you already have python 3.12+ installed, you may 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.

- Ensure prerequisites are installed
- [Git](https://github.com/git-guides/install-git#install-git-on-windows) (or `winget install git.git`)
Expand Down Expand Up @@ -52,8 +52,8 @@ This method will install the most recent python3 version [via winget](https://le
<iframe width="100%" style="aspect-ratio:16/9" src="https://www.youtube-nocookie.com/embed/22RvINnZsRo" title="Installing AlgoKit on Windows" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

=== "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.
!!! 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.

- Ensure prerequisites are installed

Expand All @@ -69,7 +69,8 @@ This method will install the latest Python3 release as a dependency via Homebrew

<iframe width="100%" style="aspect-ratio:16/9" src="https://www.youtube-nocookie.com/embed/zsurtpCGmgE" title="Installing AlgoKit on macOS" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

=== "Linux" - Ensure prerequisites are installed
=== "Linux"
- Ensure prerequisites are installed

- [Python 3.12+](https://www.python.org/downloads/)

Expand All @@ -82,7 +83,7 @@ This method will install the latest Python3 release as a dependency via Homebrew
- Continue with step 2 in the following section to install via `pipx` on any OS

=== "OS agnostic"
To install AlgoKit, run the following command from a terminal.
To install AlgoKit, run the following command from a terminal.

```shell
pipx install algokit
Expand Down

0 comments on commit 1ba1c0a

Please sign in to comment.