https://github.com/e-roy/create-web3
a quick start boilerplate for developing web3 apps and deploying smart contracts.
https://github.com/e-roy/create-web3
boilerplate create-web3 ethereum foundry hardhat nextjs react typescript web3
Last synced: 3 months ago
JSON representation
a quick start boilerplate for developing web3 apps and deploying smart contracts.
- Host: GitHub
- URL: https://github.com/e-roy/create-web3
- Owner: e-roy
- License: mit
- Created: 2022-04-21T18:33:28.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-09T15:29:06.000Z (about 2 years ago)
- Last Synced: 2025-02-16T22:34:23.910Z (3 months ago)
- Topics: boilerplate, create-web3, ethereum, foundry, hardhat, nextjs, react, typescript, web3
- Language: Solidity
- Homepage: https://create-web3.xyz
- Size: 359 KB
- Stars: 90
- Watchers: 3
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```bash
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](https://nextjs.org/) | React Framework |
| [Vite JS](https://vitejs.dev/) | Next Generation Frontend Tooling |
| ------ | ------ CSS Framework ------ |
| none | |
| [Tailwind](https://tailwindcss.com/) | A utility-first CSS framework |
| [Chakra](https://chakra-ui.com/) | A simple, modular and accessible component library that gives you the building blocks you need to build your React applications. |
| ------ | ------ Ethereum Development Environment ------ |
| [Hardhat](https://hardhat.org/) | Ethereum development environment for professionals |
| [Foundry](https://getfoundry.sh/) | a blazing fast, portable and modular toolkit for Ethereum application development written in Rust. |
| ------ | ------ Included Libraries ------ |
| [WAGMI](https://wagmi.sh/) | A set of React Hooks for Web3 |
| [RainbowKit](https://www.rainbowkit.com/docs/introduction) | RainbowKit is a React library that makes it easy to add wallet connection to your dapp. |
## Documentation
Please visit [create-web3.xyz](https://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](https://github.com/e-roy/create-web3/discussions). I would love to hear from you. 🙂
## Issues
If you find a bug or would like to request a feature, please visit [ISSUES](https://github.com/e-roy/create-web3/issues)