generated from scaffold-eth/scaffold-eth-2
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
035f2e8
commit f4db23a
Showing
1 changed file
with
9 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,16 @@ | ||
| # 🏗 Scaffold-ETH 2 | ||
| # dice Dice Demonstration | ||
|
|
||
| <h4 align="center"> | ||
| <a href="https://docs.scaffoldeth.io">Documentation</a> | | ||
| <a href="https://scaffoldeth.io">Website</a> | ||
| </h4> | ||
| # Project Overview | ||
|
|
||
| 🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts. | ||
| ### Dice | ||
|
|
||
| ⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, and Typescript. | ||
| ### Host | ||
|
|
||
| - ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it. | ||
| - 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet. | ||
| - 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network. | ||
| ### Users | ||
|
|
||
|  | ||
| ### Rolling | ||
|
|
||
| ## Requirements | ||
| ## Contributing | ||
|
|
||
| Before you begin, you need to install the following tools: | ||
|
|
||
| - [Node (v18 LTS)](https://nodejs.org/en/download/) | ||
| - Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install)) | ||
| - [Git](https://git-scm.com/downloads) | ||
|
|
||
| ## Quickstart | ||
|
|
||
| To get started with Scaffold-ETH 2, follow the steps below: | ||
|
|
||
| 1. Clone this repo & install dependencies | ||
|
|
||
| ``` | ||
| git clone https://github.com/scaffold-eth/scaffold-eth-2.git | ||
| cd scaffold-eth-2 | ||
| yarn install | ||
| ``` | ||
|
|
||
| 2. Run a local network in the first terminal: | ||
|
|
||
| ``` | ||
| yarn chain | ||
| ``` | ||
|
|
||
| This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in `hardhat.config.ts`. | ||
|
|
||
| 3. On a second terminal, deploy the test contract: | ||
|
|
||
| ``` | ||
| yarn deploy | ||
| ``` | ||
|
|
||
| This command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script. | ||
|
|
||
| 4. On a third terminal, start your NextJS app: | ||
|
|
||
| ``` | ||
| yarn start | ||
| ``` | ||
|
|
||
| Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the contract component or the example ui in the frontend. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. | ||
|
|
||
| Run smart contract test with `yarn hardhat:test` | ||
|
|
||
| - Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts` | ||
| - Edit your frontend in `packages/nextjs/pages` | ||
| - Edit your deployment scripts in `packages/hardhat/deploy` | ||
|
|
||
| ## Documentation | ||
|
|
||
| Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2. | ||
|
|
||
| To know more about its features, check out our [website](https://scaffoldeth.io). | ||
|
|
||
| ## Contributing to Scaffold-ETH 2 | ||
|
|
||
| We welcome contributions to Scaffold-ETH 2! | ||
|
|
||
| Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2. | ||
| Step by step "fork-and-pull" Github contributing using CLI refresher here: | ||
| https://gist.github.com/ZakGriffith/69d1eb8baebddd7d370b87a65a7e3ec0 |