https://github.com/subtopia-algo/algokit-subtopia-template
A highly customizable starter template for a React based Algorand dApp, integrated with the subtopia-js-sdk.
https://github.com/subtopia-algo/algokit-subtopia-template
algokit algokit-template algorand blockchain nft react subscriptions web3
Last synced: 17 days ago
JSON representation
A highly customizable starter template for a React based Algorand dApp, integrated with the subtopia-js-sdk.
- Host: GitHub
- URL: https://github.com/subtopia-algo/algokit-subtopia-template
- Owner: subtopia-algo
- Created: 2023-12-04T23:36:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-05T17:22:00.000Z (over 1 year ago)
- Last Synced: 2023-12-06T02:27:01.744Z (over 1 year ago)
- Topics: algokit, algokit-template, algorand, blockchain, nft, react, subscriptions, web3
- Language: TypeScript
- Homepage: https://algokit.subtopia.io
- Size: 89.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-algorand - algokit-subtopia-template - Algokit community template for quick starting a dapp frontend project interacting with Subtopia platform. (Learning Resources / AlgoKit Community Templates)
README
---
This template is a starter template for building an Algorand based dApp on React with [`subtopia-js-sdk`](https://github.com/subtopia-algo/subtopia-js) integration. The template is based on the official [`algokit-react-template`](https://github.com/algorandfoundation/algokit-react-frontend-template).
To get started execute the following command:
```shell
algokit init --template-url https://github.com/subtopia-algo/algokit-subtopia-template
```
## Features
The template offers two presets, the recommended preset includes all of the features included in the official [algokit-react-frontend-template](https://github.com/algorandfoundation/algokit-react-frontend-template), a custom preset allows you to select which features you want to include in your project.
The full list of features includes the following:
- Subtopia SDK integration for interacting with the Subtopia protocol. Includes a sample TestNet based subscription integrated.
- React web app with [Tailwind CSS](https://tailwindcss.com/) and [TypeScript](https://www.typescriptlang.org/)
- Styled framework agnostic CSS components using [DaisyUI](https://daisyui.com/).
- Starter jest unit tests for typescript functions. Can be disabled if not needed.
- Starter [playwright](https://playwright.dev/) tests for end to end testing. Can be disabled if not needed.
- Integration with [use-wallet](https://github.com/txnlab/use-wallet) for connecting to Algorand wallets such as Pera, Defly and Exodus.
- Example of performing a transaction.
- Dotenv support for environment variables, as well as a local only KMD provider that can be used for connecting the frontend component to an `algokit localnet` instance (docker required).
- CI/CD pipeline using GitHub Actions (Vercel or Netlify for hosting)
# Getting started
Once the template is instantiated you can follow the [README.md](template_content/README.md.jinja) file to see instructions for how to use the template.