Algorand React Boilerplate

This boilerplate is designed to get you up and running with a Algorand-based web application. Built with React, Vite, Chakra UI, and incorporating the UseWallet library from @txnlab, it provides some of the basics that you need for creating and managing Algorand transactions in a sleek, user-friendly interface.

Features

  • React for building user interfaces.
  • Vite for a super-fast development and build experience.
  • Chakra UI for a modern component library.
  • UseWallet library integration from txnlab to easily connect and interact with Algorand wallets such as Pera, Defly, Exodus, Daffi Wallet.

Getting Started

Prerequisites

Ensure you have the following installed on your system:

Installation

  1. Clone this repository:

    git clone https://github.com/wxcocoxw/algorand-react-boilerplate.git

  2. Navigate to the project directory:

    cd algorand-react-boilerplate

  3. Install the dependencies:

    Using npm: npm install

    Using Yarn: yarn

  4. Configure your environment variables & rename sample.env

  5. Start the development server:

    Using npm: npm run dev

    Using Yarn: yarn dev

Open http://localhost:3000 to view your app in the browser.

Documentation

Connecting Wallets

To connect wallets, we use the Use-Wallet library. You can find detailed documentation here.

Styling with Chakra UI

For more about using Chakra UI components, please refer to the official Chakra UI documentation.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you'd like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

coco (SockHodler)