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

master < staging #1220

Merged
merged 23 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
3a48607
add utils script
ryanRfox Nov 1, 2023
bc00925
fix typo
0xSooki Oct 30, 2023
6d53d7c
Adding some example code to write smart signatures that check against…
CiottiGiorgio Dec 11, 2023
4ce33ad
add service credits
ryanRfox Nov 2, 2023
a34f3fd
[create-pull-request] automated change
barnjamin Nov 20, 2023
859d1a4
Update install.md
bwmx Nov 26, 2023
6a584f2
[create-pull-request] automated change
barnjamin Dec 4, 2023
7fc14e1
Added guideline to smart signature use.
CiottiGiorgio Dec 5, 2023
8b71933
[create-pull-request] automated change
barnjamin Dec 7, 2023
fb0dd45
updates for latest utils releases
ryanRfox Dec 18, 2023
7bb1683
[create-pull-request] automated change
barnjamin Dec 20, 2023
e2fdc9d
Merge pull request #1210 from ryanRfox/fox/utils
nullun Dec 20, 2023
74c7a52
Merge pull request #1219 from algorand/automatic-pr-go-algorand-v3.21…
nullun Dec 20, 2023
3e1a163
Metrika discontinued
nullun Jan 5, 2024
5341a63
Replace outdated explorer info
nullun Jan 5, 2024
b05c307
Include Pera Explorer testnet links
nullun Jan 5, 2024
795eeb8
[create-pull-request] automated change
barnjamin Jan 9, 2024
f3be1a8
Merge pull request #1224 from algorand/automatic-pr-go-algorand-v3.21…
nullun Jan 9, 2024
77cffe2
Bump gitpython from 3.1.37 to 3.1.41
dependabot[bot] Jan 10, 2024
b53a6db
Merge pull request #1225 from algorand/dependabot/pip/gitpython-3.1.41
nullun Jan 10, 2024
5a43271
Merge pull request #1218 from algorand/parallel-network-lsig-code-sni…
nullun Jan 12, 2024
dded637
Merge pull request #1222 from nullun/remove-metrika
nullun Jan 12, 2024
fed93ae
Merge pull request #1223 from nullun/fix-explorer-links
nullun Jan 12, 2024
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
2 changes: 1 addition & 1 deletion .go-algorand-beta.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.20.1-beta
v3.21.0-beta
2 changes: 1 addition & 1 deletion .go-algorand-stable.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.20.1-stable
v3.21.0-stable
43 changes: 43 additions & 0 deletions docs/get-details/algokit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
title: AlgoKit

AlgoKit is a collection of tools and libraries that make it easy to build applications on Algorand.

# CLI Tool

The [AlgoKit CLI Tool](https://github.com/algorandfoundation/algokit-cli) provides a command line interface developers building applications on Algorand.

Using the CLI tool a developer can, among other things, spin up or manage a [local network](#localnet) or initialize a new project from a [Template](#templates).

## LocalNet

The AlgoKit `localnet` sub-command allows a developer to quickly spin up a private network in a local docker container. This is useful for testing and development. This command replaces the need to install a local node manually or with the Sandbox.

Simply running
```sh
$ algokit localnet start
```

Will download the required docker containers and spin up a network listening on the same ports as Sandbox and create and fund a set of accounts for the developer to use.

[More information](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/localnet.md)

## Templates

The AlgoKit `init` sub-command allows a developer to instantly initialize a new project from a template. A default set of templates is provided by the AlgoKit CLI tool, but any template can be used by passing the `--template-url` flag.

Simply running
```sh
$ algokit init
```

Will take the developer through a set of prompts to initialize a new project. The developer can choose from a set of templates and the CLI tool will download the template and initialize the project in a new directory. All parameters can also be provided as command line arguments.

[More information](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/init.md)

# Utilities

There are a set of libraries that `AlgoKit` provides to make it easier to build solutions on Algorand. These libraries are written with developer experience in mind as a wrapper over the core algosdk libraries and abstract the most common tasks away from the developer as well as providing some advanced features such as idempotent smart contract deployment.

- [Python](https://github.com/algorandfoundation/algokit-utils-py)
- [TypeScript/JS](https://github.com/algorandfoundation/algokit-utils-ts)

3 changes: 2 additions & 1 deletion docs/get-details/algokit/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: AlgoKit
arrange:
- index.md
- features
- utils
- cli-reference.md
- tutorials
- architecture-decisions
- articles
- articles
12 changes: 12 additions & 0 deletions docs/get-details/algokit/utils/py/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
title: Python

arrange:
- index.md
- capabilities
- apidocs.mdtitle: TypeScript

arrange:
- index.md
- capabilities
- client_generator.md
- apidocs.md
Loading
Loading