e-roy / create-web3

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

create-web3

A boilerplate for creating a web3 projects

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

2. Run yarn or npm install to install all the dependencies
3. Once installation is complete, cd into your app's directory and run yarn chain or npm run chain to start a local hardhat environment
4. Open another terminal and cd into your app's directory
5. Run yarn deploy or npm run deploy to deploy the example contract locally
6. 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

create-web3's Issues

Missing Deploy script with Foundry

What happened?

When booting the project with Foundry and following the quick start steps we cannot deploy the contract. The deploy script seems to be missing from the package.

What was Expected?

We should be able to deploy a contract with Foundry.

Relevant log output

yarn deploy
yarn run v1.22.18
error Command "deploy" not found.

Proposed Solution

No response

Additional Information

No response

Add documentation on flags for different tools

Description

Add descriptive documentation for the different flags and their combinations for choosing between React frontend environments, CSS frameworks and Ethereum development environments.

Why is this needed?

Simplifies usage of the tool for beginners.

Proposed Solution or API

Available options:

• --ts or --typescript: Use TypeScript instead of JavaScript.
• --use-npm: Use npm for installing dependencies.
• --use-pnpm: Use pnpm for installing dependencies.

Along these lines

Additional Information

No response

Dependency issue

What happened?

I used npx create-web3 to create the project, but when I went into packages/frontend to install the dependencies using "npm install" I got an error.

What was Expected?

when using "npm install" to install all dependencies with no issues

Relevant log output

frontend git:(main) ✗ npm install
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: @create-web3/[email protected]
npm ERR! Found: @nomiclabs/[email protected]
npm ERR! node_modules/@nomiclabs/hardhat-ethers
npm ERR!   dev @nomiclabs/hardhat-ethers@"npm:hardhat-deploy-ethers@^0.3.0-beta.10" from @create-web3/[email protected]
npm ERR!   packages/backend
npm ERR!     @create-web3/[email protected]
npm ERR!     node_modules/@create-web3/backend
npm ERR!       workspace packages/backend from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer @nomiclabs/hardhat-ethers@"^2.0.0" from @nomiclabs/[email protected]
npm ERR! node_modules/@nomiclabs/hardhat-waffle
npm ERR!   dev @nomiclabs/hardhat-waffle@"^2.0.3" from @create-web3/[email protected]
npm ERR!   packages/backend
npm ERR!     @create-web3/[email protected]
npm ERR!     node_modules/@create-web3/backend
npm ERR!       workspace packages/backend from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!

Proposed Solution

No response

Additional Information

No response