You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[AlgoKit](https://github.com/algorandfoundation/algokit-cli) - One-stop shop tool for developers building on the Algorand network; [docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md), [intro tutorial](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/intro.md)
153
153
-[Algorand TypeScript](https://github.com/algorandfoundation/puya-ts/) - A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM); [docs](https://github.com/algorandfoundation/puya-ts/), [examples](https://github.com/algorandfoundation/puya-ts/tree/main/examples)
154
154
-[AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts) - A set of core Algorand utilities that make it easier to build solutions on Algorand.
Copy file name to clipboardExpand all lines: examples/starter/README.md
+13-11Lines changed: 13 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -16,15 +16,18 @@ This project has been generated using AlgoKit. See below for default getting sta
16
16
### Initial Setup
17
17
18
18
#### 1. Clone the Repository
19
+
19
20
Start by cloning this repository to your local machine.
20
21
21
22
#### 2. Install Pre-requisites
23
+
22
24
Ensure the following pre-requisites are installed and properly configured:
23
25
24
26
-**Docker**: Required for running a local Algorand network.
25
27
-**AlgoKit CLI**: Essential for project setup and operations. Verify installation with `algokit --version`, expecting `2.6.0` or later.
26
28
27
29
#### 3. Bootstrap Your Local Environment
30
+
28
31
Run the following commands within the project folder:
29
32
30
33
-**Setup Project**: Execute `algokit project bootstrap all` to install dependencies and setup npm dependencies.
@@ -34,14 +37,16 @@ Run the following commands within the project folder:
34
37
### Development Workflow
35
38
36
39
#### Terminal
40
+
37
41
Directly manage and interact with your project using AlgoKit commands:
38
42
39
43
1.**Build Contracts**: `algokit project run build` compiles all smart contracts. You can also specify a specific contract by passing the name of the contract folder as an extra argument.
40
-
For example: `algokit project run build -- hello_world` will only build the `hello_world` contract.
44
+
For example: `algokit project run build -- hello_world` will only build the `hello_world` contract.
41
45
2.**Deploy**: Use `algokit project deploy localnet` to deploy contracts to the local network. You can also specify a specific contract by passing the name of the contract folder as an extra argument.
42
-
For example: `algokit project deploy localnet -- hello_world` will only deploy the `hello_world` contract.
46
+
For example: `algokit project deploy localnet -- hello_world` will only deploy the `hello_world` contract.
47
+
48
+
#### VS Code
43
49
44
-
#### VS Code
45
50
For a seamless experience with breakpoint debugging and other features:
46
51
47
52
1.**Open Project**: In VS Code, open the repository root.
@@ -50,20 +55,22 @@ For a seamless experience with breakpoint debugging and other features:
50
55
- Use `F5` to start debugging.
51
56
52
57
#### JetBrains IDEs
58
+
53
59
While primarily optimized for VS Code, JetBrains IDEs are supported:
54
60
55
61
1.**Open Project**: In your JetBrains IDE, open the repository root.
56
62
2.**Automatic Setup**: The IDE should configure the Node.js environment.
57
63
3.**Debugging**: Use `Shift+F10` or `Ctrl+R` to start debugging. Note: Windows users may encounter issues with pre-launch tasks due to a known bug. See [JetBrains forums](https://youtrack.jetbrains.com/issue/IDEA-277486/Shell-script-configuration-cannot-run-as-before-launch-task) for workarounds.
58
64
59
65
## AlgoKit Workspaces and Project Management
66
+
60
67
This project supports both standalone and monorepo setups through AlgoKit workspaces. Leverage [`algokit project run`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/run.md) commands for efficient monorepo project orchestration and management across multiple projects within a workspace.
61
68
62
69
## AlgoKit Generators
63
70
64
71
This template provides a set of [algokit generators](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/generate.md) that allow you to further modify the project instantiated from the template to fit your needs, as well as giving you a base to build your own extensions to invoke via the `algokit generate` command.
65
72
66
-
### Generate Smart Contract
73
+
### Generate Smart Contract
67
74
68
75
By default the template creates a single `HelloWorld` contract under hello_world folder in the `smart_contracts` directory. To add a new contract:
69
76
@@ -75,7 +82,7 @@ By default the template creates a single `HelloWorld` contract under hello_world
75
82
76
83
### Generate '.env' files
77
84
78
-
By default the template instance does not contain any env files to deploy to different networks. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
85
+
By default the template instance does not contain any env files to deploy to different networks. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
79
86
80
87
To generate a new `.env` or `.env.{target_network}` file, run `algokit generate env-file`
81
88
@@ -85,23 +92,18 @@ This project is optimized to work with AlgoKit AVM Debugger extension. To activa
85
92
86
93
Refer to the commented header in the `index.ts` file in the `smart_contracts` folder.Since you have opted in to include VSCode launch configurations in your project, you can also use the `Debug TEAL via AlgoKit AVM Debugger` launch configuration to interactively select an available trace file and launch the debug session for your smart contract.
87
94
88
-
89
95
For information on using and setting up the `AlgoKit AVM Debugger` VSCode extension refer [here](https://github.com/algorandfoundation/algokit-avm-vscode-debugger). To install the extension from the VSCode Marketplace, use the following link: [AlgoKit AVM Debugger extension](https://marketplace.visualstudio.com/items?itemName=algorandfoundation.algokit-avm-vscode-debugger).
90
96
91
97
# Tools
92
98
93
99
This project makes use of Algorand TypeScript to build Algorand smart contracts. The following tools are in use:
-[AlgoKit](https://github.com/algorandfoundation/algokit-cli) - One-stop shop tool for developers building on the Algorand network; [docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md), [intro tutorial](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/intro.md)
97
103
-[Algorand TypeScript](https://github.com/algorandfoundation/puya-ts/) - A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM); [docs](https://github.com/algorandfoundation/puya-ts/), [examples](https://github.com/algorandfoundation/puya-ts/tree/main/examples)
98
104
-[AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts) - A set of core Algorand utilities that make it easier to build solutions on Algorand.
99
105
-[NPM](https://www.npmjs.com/): TypeScript packaging and dependency management.
100
106
-[TypeScript](https://www.typescriptlang.org/): Strongly typed programming language that builds on JavaScript
101
107
-[ts-node-dev](https://github.com/wclr/ts-node-dev): TypeScript development execution environment
102
108
103
-
104
109
It has also been configured to have a productive dev experience out of the box in [VS Code](https://code.visualstudio.com/), see the [.vscode](./.vscode) folder.
- [AlgoKit](https://github.com/algorandfoundation/algokit-cli) - One-stop shop tool for developers building on the Algorand network; [docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md), [intro tutorial](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/intro.md)
161
161
- [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts/) - A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM); [docs](https://github.com/algorandfoundation/puya-ts/), [examples](https://github.com/algorandfoundation/puya-ts/tree/main/examples)
162
162
- [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts) - A set of core Algorand utilities that make it easier to build solutions on Algorand.
0 commit comments