Skip to content

Latest commit

 

History

History
210 lines (162 loc) · 6.63 KB

README.md

File metadata and controls

210 lines (162 loc) · 6.63 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Vite ethers.js template

A handy template for a quick start of a React project using Vite and Web3React with ethers.js
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

You can start working on building UI for dApps right away with this template made with Vitejs and Web3React(ethers.js)

Built With

  • React
  • TypeScript
  • Vite
  • Web3React

Usage

You can use this template for a quick start without configuration of Vite and Web3React in React project.

You can also refer to sample components under src/components/ directory.

SimpleConnectButton.tsx

This component shows how to implement connect/disconnect button for MetaMask browser extension.

ContractInteractionSample.tsx

This component shows how to interact with contracts using useContract hook.

Getting Started

Installation

  1. Clone the repo 
    git clone https://github.com/masafumimori/vite-ethersjs-template
    or Press Use this template button at the top right on this page.
  2. Install NPM packages 
    npm install
or
yarn install
  3. Start the project 
    npm run dev
or
yarn dev

Build

  1. To build, run 
    npm run build
or
yarn build

Lint/Format

To lint, run

npm run lint
or
yarn lint

To format, run

npm run format
or
yarn format

(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

License

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

Contact

Masafumi Mori - m.masasafumi[at]outlook.com

Project Link: https://github.com/masafumimori/vite-ethersjs-template

Acknowledgments

(back to top)