From 11d3d1d3aa8594ece95a1ebc311e40f97d5c2ff6 Mon Sep 17 00:00:00 2001 From: Rinat Date: Sat, 28 Dec 2024 14:24:13 +0100 Subject: [PATCH 1/8] feat: update readme --- README.md | 82 +++++-------------------------------------------------- 1 file changed, 7 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index c2434a1f2..1695b3759 100644 --- a/README.md +++ b/README.md @@ -4,93 +4,25 @@ # 🏗 create-eth -CLI to create decentralized applications (dapps) using Scaffold-ETH 2. - -This is an alternative method of installing Scaffold-ETH. Instead of directly [cloning SE-2](https://docs.scaffoldeth.io/quick-start/installation#option-1-setup-using-git-clone), you can use create-eth to create your own custom instance, where you can choose among several configurations and extensions. +CLI to create decentralized applications (dapps) using [Scaffold-ETH 2](https://github.com/scaffold-eth/scaffold-eth-2).

- SE-2 Repo | - SE-2 Docs | + SE-2 Repository | + SE-2 Documentation | SE-2 Website

-## Requirements - -Before you begin, you need to install the following tools: - -- [Node (>= v18.18)](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. Install from NPM Registry and follow the CLI instructions. - -``` -npx create-eth@latest -``` - -> 💬 Hint: If you choose Foundry as solidity framework in the CLI, you'll also need Foundryup installed in your machine. Checkout: [getfoundry.sh](https://getfoundry.sh) - -2. Run a local network in the first terminal: - -``` -yarn chain -``` - -This command starts a local Ethereum network using Hardhat or Foundry, depending on which one you selected in the CLI. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in: - -- `packages/hardhat/hardhat.config.ts` if you have Hardhat as solidity framework. -- `packages/foundry/foundry.toml` if you have Foundry as solidity framework. - -3. On a second terminal, deploy the test contract: - -``` -yarn deploy -``` - -This command deploys a test smart contract to the local network. The contract can be modified to suit your needs. Is located in: - -- Hardhat => `packages/hardhat/contracts` -- Foundry => `packages/foundry/contracts` - -The `yarn deploy` command uses a deploy script to deploy the contract to the network. You can customize it. Is located in: - -- Hardhat => `packages/hardhat/deploy` -- Foundry => `packages/foundry/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 `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. - -Run smart contract test with `yarn hardhat:test` or `yarn foundry:test` depending of your solidity framework. - -**What's next**: - -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) +## Getting Started -## Documentation +How to create and configure your dapp using create-eth: [QuickStart Guide](https://docs.scaffoldeth.io/quick-start) 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). -## Contributing to create-eth +## Contributing -We welcome contributions to create-eth and Scaffold-ETH 2! +We welcome contributions to both create-eth and Scaffold-ETH 2! For more information and guidelines for contributing, please see: From 0359d1abf6f04edc5876598b3ff9c29cb76b5075 Mon Sep 17 00:00:00 2001 From: Rinat Date: Fri, 3 Jan 2025 19:33:34 +0100 Subject: [PATCH 2/8] fix: return requirements and quick start --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 49 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1695b3759..2ad2f7d5a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,60 @@ -> ⚠️ Under active development. -> -> If you find any bug, please report as [issue](https://github.com/scaffold-eth/create-eth/issues) or send a message in [🏗 scaffold-eth developers chat](https://t.me/joinchat/F7nCRK3kI93PoCOk) +## 🏗 create-eth -# 🏗 create-eth - -CLI to create decentralized applications (dapps) using [Scaffold-ETH 2](https://github.com/scaffold-eth/scaffold-eth-2). +CLI to create decentralized applications (dapps) using Scaffold-ETH 2.

- SE-2 Repository | SE-2 Documentation | SE-2 Website

-## Getting Started +## Requirements + +Before you begin, you need to install the following tools: + +- [Node (>= v18.18)](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. Install the latest version of Scaffold-ETH 2 + +``` +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: + +``` +yarn chain +``` + +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: + +``` +yarn deploy +``` + +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: + +``` +yarn start +``` + +Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. -How to create and configure your dapp using create-eth: [QuickStart Guide](https://docs.scaffoldeth.io/quick-start) +## Documentation Visit our [docs](https://docs.scaffoldeth.io) to learn all the technical details and guides of Scaffold-ETH 2. From da76c8cc04b53c825b64e5c2d785b327247965c6 Mon Sep 17 00:00:00 2001 From: Rinat Date: Fri, 3 Jan 2025 19:37:32 +0100 Subject: [PATCH 3/8] chore: changeset --- .changeset/sharp-eels-bow.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/sharp-eels-bow.md diff --git a/.changeset/sharp-eels-bow.md b/.changeset/sharp-eels-bow.md new file mode 100644 index 000000000..5cc7e8e5b --- /dev/null +++ b/.changeset/sharp-eels-bow.md @@ -0,0 +1,5 @@ +--- +"create-eth": patch +--- + +update readme From 09fe4898ca981b2aa9626f2ced7a2078d164c553 Mon Sep 17 00:00:00 2001 From: Rinat Date: Mon, 6 Jan 2025 13:03:56 +0100 Subject: [PATCH 4/8] fix: what's next --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ad2f7d5a..18c36b1b8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## 🏗 create-eth +# 🏗 create-eth CLI to create decentralized applications (dapps) using Scaffold-ETH 2. @@ -54,6 +54,10 @@ yarn start Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. +**What's next**: + +Visit the [What's next section of our docs](https://docs.scaffoldeth.io/quick-start/environment#whats-next) to learn how to customize your contracts, frontend, and more. + ## Documentation Visit our [docs](https://docs.scaffoldeth.io) to learn all the technical details and guides of Scaffold-ETH 2. From 5bed5cbb39466d7b8cac880547f72559474ebd57 Mon Sep 17 00:00:00 2001 From: Rinat Date: Mon, 6 Jan 2025 13:16:59 +0100 Subject: [PATCH 5/8] feat: community section --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 18c36b1b8..dd52d5ce7 100644 --- a/README.md +++ b/README.md @@ -72,3 +72,13 @@ For more information and guidelines for contributing, please see: - [create-eth CONTRIBUTING.MD](https://github.com/scaffold-eth/create-eth/blob/main/CONTRIBUTING.md) if you want to contribute to the CLI. - [Scaffold-ETH 2 CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) if you want to contribute to SE-2 base code. + +## Community + +

+ Buidlguidl Website | + Buidlguidl X | + SE-2 Website | + SE-2 X | + SE-2 developers chat +

From eb6f6618a399f1ed96103d84cb577d2c92c92a50 Mon Sep 17 00:00:00 2001 From: pabl0cks Date: Thu, 9 Jan 2025 23:38:14 +0100 Subject: [PATCH 6/8] Move website footer links to different sections --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dd52d5ce7..0293ad833 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,11 @@ Visit our [docs](https://docs.scaffoldeth.io) to learn all the technical details To know more about its features, check out our [website](https://scaffoldeth.io). +Watch [BG Labs](https://www.youtube.com/playlist?list=PLJz1HruEnenIXdGq6kqJSNvXD-ZZkqXn_) - our video series on building with Scaffold-ETH 2. + ## Contributing -We welcome contributions to both create-eth and Scaffold-ETH 2! +Built by [BuidlGuidl](https://buidlguidl.com) builders, we welcome contributions to both create-eth and Scaffold-ETH 2! For more information and guidelines for contributing, please see: @@ -76,9 +78,7 @@ For more information and guidelines for contributing, please see: ## Community

- Buidlguidl Website | Buidlguidl X | - SE-2 Website | SE-2 X | SE-2 developers chat

From 7dc8a2b7398ca65bde044a2049de65c1c3f828c2 Mon Sep 17 00:00:00 2001 From: Shiv Bhonde Date: Fri, 10 Jan 2025 11:09:53 +0530 Subject: [PATCH 7/8] fix BG labs link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0293ad833..3c892bb63 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Visit our [docs](https://docs.scaffoldeth.io) to learn all the technical details To know more about its features, check out our [website](https://scaffoldeth.io). -Watch [BG Labs](https://www.youtube.com/playlist?list=PLJz1HruEnenIXdGq6kqJSNvXD-ZZkqXn_) - our video series on building with Scaffold-ETH 2. +Watch [BG Labs](https://youtube.com/playlist?list=PLJz1HruEnenD77QAsqnk7KG8rSOMk0B99&si=JXZRn78_NBcvJJoZ) - our video series on building with Scaffold-ETH 2. ## Contributing From 4cd63fc2e007307183a732c4588728785b502af0 Mon Sep 17 00:00:00 2001 From: Shiv Bhonde Date: Fri, 10 Jan 2025 11:13:59 +0530 Subject: [PATCH 8/8] remove contribution links to SE-2 repo --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3c892bb63..1ddeb09d1 100644 --- a/README.md +++ b/README.md @@ -68,12 +68,9 @@ Watch [BG Labs](https://youtube.com/playlist?list=PLJz1HruEnenD77QAsqnk7KG8rSOMk ## Contributing -Built by [BuidlGuidl](https://buidlguidl.com) builders, we welcome contributions to both create-eth and Scaffold-ETH 2! +Built by [BuidlGuidl](https://buidlguidl.com) builders, we welcome contributions to create-eth! -For more information and guidelines for contributing, please see: - -- [create-eth CONTRIBUTING.MD](https://github.com/scaffold-eth/create-eth/blob/main/CONTRIBUTING.md) if you want to contribute to the CLI. -- [Scaffold-ETH 2 CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) if you want to contribute to SE-2 base code. +For more information and guidelines for contributing, please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/create-eth/blob/main/CONTRIBUTING.md) ## Community