Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 3.02 KB

README.md

File metadata and controls

102 lines (71 loc) · 3.02 KB
Raw

Creat Own React App Template (CRA)

Node version npm GitHub

This React Starter is a preconfigured Create React App (CRA) template for the decentralized applications in blockchain. You can start building your app with Zero configuration.

Usage

yarn create react-app your-project-name --template @clusterh/react-starter

Or

npx create-react-app your-project-name --template @clusterh/react-starter

Next

cd your_project_name

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

This CRA template includes

  • React
  • Redux Toolkit
  • React Router
  • Axios
  • @web3-react/core
  • @davatar/react
  • Ethers
  • Styled-components
  • Typescript
  • React-snippers
  • react-toastify
  • Code Splitting
  • Global style system
  • Metamask, WalletConnect connection
  • Ethereum Mainnet, Goerli Testnet web3 config
  • ESLint, Prettier configuration

Advantages

  • Fully configurated web3 stuff to interact with smart contract.
  • Wallet Conenction implemented with Metamask, WalletConnect
  • Added Global style theme, basic components, layouts based in styled-components, flex layout.
  • Configured ESLint, Prettier
  • Typescript supported

More feature coming on the way...

Quick Start

After installing the template

  1. Add ethereum, goerli Alchemy key in .env file and restart the app
REACT_APP_ALCHEMY_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
REACT_APP_ALCHEMY_KEY_GOERLI = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  1. Update environment value for your production
REACT_APP_ENVIRONMENT = "prod"

  1. Update/Add smart contract address, abi with your deployed address in src/config/web3Connect/web3.ts/EXAMPLE_CONTRACT_ADDRESSES, src/config/abis/exampleContractABI.json file.

  2. Check/Update web3 helpers in src/utils/web3Helpers.ts, Add functions to interact with smart contract in src/utils/web3CallHelpers.ts file.

  3. Update your global theme in src/styles/globalStyles.ts, src/styles/theme.ts file.

  4. Add/Update redux state in src/state file.

  5. Edit the Lint rules in .eslintrc.json, .prettierrc file.

License

The MIT License (MIT). Please see License File for more information.

Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️