Skip to content

a quick start boilerplate for developing web3 apps and deploying smart contracts.

License

Notifications You must be signed in to change notification settings

e-roy/create-web3

Repository files navigation

create-web3

A boilerplate for creating a web3 projects

Version Downloads per month License

This boilerplate quickly creates a mono repo with 2 environments, a react frontend environment and a Ethereum development environment for writing, testing and deploying contracts.

Quick Start Notes

  1. To start install
npx create-web3
  1. Run yarn or npm install to install all the dependencies
  2. Once installation is complete, cd into your app's directory and run yarn chain or npm run chain to start a local hardhat environment
  3. Open another terminal and cd into your app's directory
  4. Run yarn deploy or npm run deploy to deploy the example contract locally
  5. Run yarn dev or npm run dev to start your Next dev environment

Technologies

This project is built with the following open source libraries, frameworks and languages. User choice of framework used, available in plain js or typescript.

Tech Description
------ ------ React Frontend Environment ------
Next JS React Framework
Vite JS Next Generation Frontend Tooling
------ ------ CSS Framework ------
none
Tailwind A utility-first CSS framework
Chakra A simple, modular and accessible component library that gives you the building blocks you need to build your React applications.
------ ------ Ethereum Development Environment ------
Hardhat Ethereum development environment for professionals
Foundry a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
------ ------ Included Libraries ------
WAGMI A set of React Hooks for Web3
RainbowKit RainbowKit is a React library that makes it easy to add wallet connection to your dapp.

Documentation

Please visit create-web3.xyz to view the full documentation.

Discussions

If you have questions how to use, want to suggest a feature, or show off a project you created with create-web3, join discussions on GitHub. I would love to hear from you. 🙂

Issues

If you find a bug or would like to request a feature, please visit ISSUES