data-miner00/algorand-react-template

Template for building Algorand Dapp

Algorand React Template

An opionionated React Template that is built for customization!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Design
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

Screenshot of the application before connecting to a wallet

Screenshot of the application after connecting to a wallet

---

An extremely opinionated template for building Algorand Dapps with React. Focus on the application itself rather than all these low-level configuration stuffs.

Incentives:

• Wanted to build a web portal with algosdk
• Don't want to use create-react-app
• Don't want to use Next.js
• Buitl this React template so I can use for building Algorand Dapps.

The smart contract that the template is interacting is just a program that keeps a counter state that can be incremented or decremented by transaction. The link to smart contract here.

Note: The contract is deployed on Algorand testnet not mainnet.

(back to top)

Built With

The technologies and tools used within this template.

• React
• Esbuild
• ESLint
• TypeScript
• Jest/Testing Library
• TailwindCSS
• Framer Motion
• GitHub Workflow
• Algosdk
• Wallet Connect

(back to top)

Design

Charts are very useful to let people know the high level designs of the project. Usually people will use some of more sophisticated third-party diagramming tools such as Enterprese Architect or a light-weighted draw.io.

Contrary to the public's awareness, GitHub actually supports diagramming language Mermaid that can generate a wide array of diagrams such as flowchart, sequence diagram, class diagram and more!

graph TD;
    PorsgreSQL-->Laravel;
    avax[Avalanche C-Chain]-->Laravel;
    Laravel-->Vue.js;
    Node.js-->Vue.js;

(back to top)

Getting Started

Prerequisites

The list of tools that is used when development.

• npm

  npm install npm@latest -g

• Pnpm

  npm i -g pnpm

• Git

Installation

To use this template for personal use or contribution, simply perform the following. Do note that a total of 3 terminals are required to get the entire application up and running for development.

1. Clone the repo

   git clone https://github.com/data-miner00/algorand-react-template.git

2. Install Node dependencies

   pnpm i

3. Optionally update the dependencies

   pnpm up --latest

4. Recommend to run tests to check if things are breaking

   pnpm test

5. Optionally run lint to check if code styles are breaking

   pnpm lint

6. Run formatter to format code

   pnpm format

7. Start Esbuild (requires 1 terminal)

   pnpm watch

8. Start Tailwind JIT (requires 1 terminal)

   pnpm watch:tw

9. Finally start local dev server (requires 1 terminal)

   pnpm start

10. Compile for production

    pnpm build:tw
    pnpm build

11. Purge dist folder

    pnpm purge

(back to top)

Roadmap

• Add TypeScript
• Add ESLint
• Add Jest/Testing Library
• Add React Router (Lazy Loading)
• Add 404 page
• Add Framer Motion
• Add Styling
  • Sass
  • Tailwind
• Add i18n
  • Korean
  • Japanese
  • Chinese
• Authentication
  • OAuth 2.0? OpenID Connect?
• Prisma
• Dark mode
• Add GitHub workflows
• Add PWA Manifest

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

• Why You Should Use ESBuild OVER Webpack for React Projects
• esbuild homepage
• SyntaxError: Support for the experimental syntax jsx isn’t currently enabled
• Robots.txt
• useHooks
• Configuring Public Path
• eslint-config-prettier
• Issue Template
• [Feature] read substitution variables from .env file
• ESLint Typescript
• GitHub Actions
• Pnpm CI
• global is not defined
• node-stdlib-browser
• (Advanced) Quest 11: Building and deploying a dApp!

(back to top)