Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

staging => master #1253

Merged
merged 4 commits into from
Mar 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading