From cde3f86650077b820aaf7c36624cca3ad40d2df5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez?= Date: Thu, 21 Nov 2024 08:07:48 +0100 Subject: [PATCH 1/5] Remove clone --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 767baca82..3f3d46491 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,10 @@ Before you begin, you need to install the following tools: To get started with Scaffold-ETH 2, follow the steps below: -1. Clone this repo & install dependencies +1. Install the latest version of Scaffold-ETH 2 ``` -git clone https://github.com/scaffold-eth/scaffold-eth-2.git -cd scaffold-eth-2 -yarn install +npx create-eth@latest ``` 2. Run a local network in the first terminal: From e5a666b78c5f7c8dfc8f827643128612dd23c71f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez?= Date: Thu, 21 Nov 2024 08:10:03 +0100 Subject: [PATCH 2/5] Note on dependencies --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3f3d46491..35a7a8d74 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ To get started with Scaffold-ETH 2, follow the steps below: npx create-eth@latest ``` +This command will install all the necessary packages and dependencies, so it might take a while. + 2. Run a local network in the first terminal: ``` From 1ff61e22015636256379b909c257cde1f574b17c Mon Sep 17 00:00:00 2001 From: pabl0cks Date: Fri, 22 Nov 2024 11:01:20 +0100 Subject: [PATCH 3/5] Add Foundry to the tech stack --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35a7a8d74..a89111aa0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ๐Ÿงช 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. -โš™๏ธ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript. +โš™๏ธ Built using NextJS, RainbowKit, Foundry/Hardhat, Wagmi, Viem, and Typescript. - โœ… **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it. - ๐Ÿช **[Custom hooks](https://docs.scaffoldeth.io/hooks/)**: Collection of React hooks wrapper around [wagmi](https://wagmi.sh/) to simplify interactions with smart contracts with typescript autocompletion. From 8027c340f94353081e3b9e9af0d1ff054c6313a3 Mon Sep 17 00:00:00 2001 From: pabl0cks Date: Fri, 22 Nov 2024 11:02:51 +0100 Subject: [PATCH 4/5] Remove hardhat specific config and point to docs --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a89111aa0..818e7777e 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ This command will install all the necessary packages and dependencies, so it mig 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`. +This command starts a local Ethereum network that runs on your local machine and can be used for testing and development. Learn how to [customize your network configuration](https://docs.scaffoldeth.io/quick-start/environment#1-initialize-a-local-blockchain). 3. On a second terminal, deploy the test contract: @@ -51,7 +51,7 @@ This command starts a local Ethereum network using Hardhat. The network runs on 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. +This command deploys a test smart contract to the local network. You can find more information about how to customize your contract and deployment script in our [documentation](https://docs.scaffoldeth.io/quick-start/environment#2-deploy-your-smart-contract). 4. On a third terminal, start your NextJS app: @@ -63,15 +63,18 @@ Visit your app on: `http://localhost:3000`. You can interact with your smart con **What's next**: -- Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts` -- Edit your frontend homepage at `packages/nextjs/app/page.tsx`. For guidance on [routing](https://nextjs.org/docs/app/building-your-application/routing/defining-routes) and configuring [pages/layouts](https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts) checkout the Next.js documentation. -- Edit your deployment scripts in `packages/hardhat/deploy` -- Edit your smart contract test in: `packages/hardhat/test`. To run test use `yarn hardhat:test` -- You can add your Alchemy API Key in `scaffold.config.ts` if you want more reliability in your RPC requests. +Visit the [What's next section of our docs](https://docs.scaffoldeth.io/quick-start/environment#whats-next) to learn how to: + +- Edit your smart contracts +- Edit your deployment scripts +- Customize your frontend +- Edit the app config +- Writing and running tests +- [Setting up external services and API keys](https://docs.scaffoldeth.io/deploying/deploy-smart-contracts#configuration-of-third-party-services-for-production-grade-apps) ## Documentation -Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2. +Visit our [docs](https://docs.scaffoldeth.io) to learn all the technical details and guides of Scaffold-ETH 2. To know more about its features, check out our [website](https://scaffoldeth.io). From 34c81e487c9bcd20280694e6311661bd7030e994 Mon Sep 17 00:00:00 2001 From: pabl0cks Date: Fri, 22 Nov 2024 11:04:21 +0100 Subject: [PATCH 5/5] Add extensions reference in installation step --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 818e7777e..75411bc6a 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,9 @@ npx create-eth@latest This command will install all the necessary packages and dependencies, so it might take a while. +> [!NOTE] +> You can also initialize your project with one of our extensions to add specific features or starter-kits. Learn more in our [extensions documentation](https://docs.scaffoldeth.io/extensions/). + 2. Run a local network in the first terminal: ```