This template is a starter template for building an Algorand based dApp on React with subtopia-js-sdk
integration. The template is based on the official algokit-react-template
.
To get started execute the following command:
algokit init --template-url https://github.com/subtopia-algo/algokit-subtopia-template
The template offers two presets, the recommended preset includes all of the features included in the official 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 and TypeScript
- Styled framework agnostic CSS components using DaisyUI.
- Starter jest unit tests for typescript functions. Can be disabled if not needed.
- Starter playwright tests for end to end testing. Can be disabled if not needed.
- Integration with 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)
Once the template is instantiated you can follow the README.md file to see instructions for how to use the template.