UNPKG

create-web3

Version:

A boilerplate for creating a web3 projects

create-web3.xyz

e-roy/create-web3

51 lines (36 loc) • 2.62 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# create-web3 boilerplate A boilerplate for starting a web3 project. 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 FrontEnd 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)