{"id":13425579,"url":"https://github.com/scale-it/algo-builder-templates","last_synced_at":"2025-07-30T10:32:37.454Z","repository":{"id":38106075,"uuid":"342399762","full_name":"scale-it/algo-builder-templates","owner":"scale-it","description":"Dapps templates for Algo Builder","archived":false,"fork":false,"pushed_at":"2022-10-06T09:00:45.000Z","size":2153,"stargazers_count":20,"open_issues_count":0,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-28T21:11:01.209Z","etag":null,"topics":["algorand","algorand-blockchain","dapp-development","dapps","dapps-templates","react"],"latest_commit_sha":null,"homepage":"https://algobuilder.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scale-it.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-25T22:47:52.000Z","updated_at":"2024-05-14T21:30:23.000Z","dependencies_parsed_at":"2023-01-19T10:01:06.198Z","dependency_job_id":null,"html_url":"https://github.com/scale-it/algo-builder-templates","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scale-it%2Falgo-builder-templates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scale-it%2Falgo-builder-templates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scale-it%2Falgo-builder-templates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scale-it%2Falgo-builder-templates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scale-it","download_url":"https://codeload.github.com/scale-it/algo-builder-templates/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228124611,"owners_count":17873170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algorand","algorand-blockchain","dapp-development","dapps","dapps-templates","react"],"created_at":"2024-07-31T00:01:15.077Z","updated_at":"2024-12-04T14:11:58.153Z","avatar_url":"https://github.com/scale-it.png","language":"JavaScript","funding_links":[],"categories":["Development \u0026 Tools","Development Tools"],"sub_categories":["Language SDKs \u0026 Tools","Languages"],"readme":"![image](https://gitcdn.link/repo/scale-it/algo-builder/master/media/logo.svg)\n# Algo Builder Templates\n\nDapp templates for [Algo Builder](https://github.com/scale-it/algo-builder).\n\nDistributed Applications (dapps) are basically decentralized applications. The templates in this repository are extremely helpful and easy to use. They are designed and implemented to provide aspiring developers a headstart in building dapps on Algorand Blockchain. The templates use [algosdk](https://github.com/algorand/js-algorand-sdk), [Algo Builder](https://github.com/scale-it/algo-builder), [Algosigner](https://github.com/PureStake/algosigner), [Wallet Connect](https://docs.walletconnect.com/quick-start/dapps/client) and [MyAlgo Wallet](https://github.com/randlabs/myalgo-connect)\n\nThe detailed description about each template and how to properly use them can be found in the `docs` directory.\n\n## Usage\n\nEach template is a single project (with 1 package.json file) comprising of:\n - An `algob` project : used to deploy ASA's, stateless and stateful contracts. Use `algob deploy` to deploy your `/scripts`. Sample algob project can  be found [here](https://github.com/scale-it/algo-builder/tree/master/packages/algob/sample-project), check the project [README.md](https://github.com/scale-it/algo-builder/blob/master/packages/algob/sample-project/README.md) for more details.\n - [create-react-app](https://github.com/facebook/create-react-app): React js application for your frontend of web dApp. You can use the `AlgoSigner` global object in your app to use it's API's. Example can be found in the `default` template.\n\nDeployment information (using `algob deploy` above) is stored in  `checkpoints` (in `/artifacts`). Checkpoint information is available for user in the React application.\n\nThe templates can be easily bootstrap using the `algob unbox-template` command.\n\nAfter successfully unboxing the template, please link the `algob` package in the template directory to use it for running scripts.\nThe steps for the process can be found [here](https://github.com/scale-it/algo-builder/#requirements).\n\nTo learn how to install and use `algob`, visit [Algo Builder](https://algobuilder.dev).\n\n## Quick Start\n\n`algob unbox-template \u003ctemplate-name\u003e \u003cdestination-directory\u003e --force (flag)`\n - if `destination-directory` is not passed then current directory will be used.\n - if `template-name` is not passed, then by default template \"/default\" is unboxed.\n - if `--force` is passed, then files are overwritten. If it isn't passed, then for each conflicting file, user is made to choose whether to overwrite that file or not.\n - if `template-name` passed is not present as an existing template, the command provides an interactive way to choose from the existing templates.\n - The command also asks if the user wants to install the dependencies as a part of the current process.\n\n## Available templates\n\n- [*htlc*](./htlc): There exists a descriptive example explaining how HTLC contracts work with Algo-Builder. It can be found [here](https://github.com/scale-it/algo-builder/tree/master/examples/htlc-pyteal-ts). Use `algob deploy` to deploy scripts: which creates and fund HTLC contract account which is defined in assets/htlc.py. Withdraw from the escrow using React frontend (after `yarn start`).\n\n- [*shop*](./shop): Template with two rows to buy tickets: a) Queens Concert (5 ALGO); b) Beyonce Concert (10 ALGO). In this template we demonstrate usage of a payment widget to trigger a purchase (in this case it would be purchasing tickets for a concert). You can connect to the network using different wallets i.e either with MyAlgo Wallet, Wallet Connect or AlgoSigner. To know more about wallet integration read [here](https://github.com/scale-it/algo-builder/blob/master/packages/web/README.md) \n\n- [*wallet*](./wallet): Demonstrate how to connect to Algorand wallet in browser and interact with smart contracts via wallets.\n\n## Add new template / Update existing template\n\nWe love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:\n\n- Reporting a bug\n- Discussing the current state of the code\n- Submitting a fix\n- Proposing new features/templates\n\nTo add a new dapp template or update an existing one, feel free to create a pull request from your fork to this repo.\n\nYou can also chat with us on the `#algo-builder` channel at the Algorand [discord](https://discord.com/invite/hbcUSuw) server.\n\n## Connect algob project settings with a webapp\n\nAn algob project can be easily connected/integrated with your dapp. You can learn how to do it in [algob webapp project settings guide](https://github.com/scale-it/algo-builder/blob/develop/docs/guide/algob-web.md#connect-algob-project-settings-with-a-webapp).\n\n## Loading assets and checkpoints in webapp\n\nAssets and checkpoints can be easily loaded in your web app. You can learn how to do it from [checkpoint guide](https://github.com/scale-it/algo-builder/blob/master/docs/guide/algob-web.md#checkpoints).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscale-it%2Falgo-builder-templates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscale-it%2Falgo-builder-templates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscale-it%2Falgo-builder-templates/lists"}