Local development environment for Algorand TEAL Smart Contracts.
- An instance of Algorand's Sandbox running on your machine. You'll need Docker and Docker Compose, please refer to Sandbox repo's README for installation instructions.
- npm
- Nodejs
Assuming you allready have previous requirements and Docker is running in your machine:
- Clone algorand-development-suite repo
- Add this project folder as bind volume in sandbox
docker-compose.yml
under keyservices.algod
:volumes: - type: bind source: <path> target: /data
- cd to /algorand-developer-suite
- Create
.env
file following.env.example
, make sure to set your local sandbox path correctly - Create
apps/
directory at root - Create
pyteal/contracts/
directory - run npm i to install dependencies
- run ./algods, to verify it installed correctly the usage guide should display
- Start developing on Algorand
TODO
algods helps you manage your local Algorand development environment.
usage:
$ algods <command>
commands:
startnet: Uses Algorand's sandbox to create a new private network
stopnet: Stops sandbox environment and deletes docker containers
getaccount: Retrieves account info
listaccounts: Lists existing accounts in your private network
createaccount: Creates a new Algorand account in your private network and
funds it with 5 algos
fundaccount: Funds an existing Algorand account
createtoken: Creates a new ASA in your private network [TODO]
build: Compiles Approval and Clear program from pyteal code [TODO]
createapp: Issues a transaction that creates an application
appinfo: Displays App info [TODO]
callapp: Issues a transaction that calls an application, uses ACCOUNT_1
from .env as sender
help: Displays this help guide
Pull Requests are more than welcome! Please read CONTRIBUTING.md for more details. You can create a new issue or give your feedback.
algorand-development-suite is licensed under an MIT license. See the LICENSE file for details.