Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Templatise readme quickstart section #790

Merged
merged 3 commits into from
Mar 28, 2024
Merged

Templatise readme quickstart section #790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ef2179
feat: templated quickstart
rin-st Mar 26, 2024
9dfd650
revert changes to template/utils.js file
technophile-04 Mar 28, 2024
790a954
add extra line in templates/utils.js
technophile-04 Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 77 additions & 24 deletions templates/base/README.md.template.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,68 @@
import { withDefaults } from "../utils.js";

const contents = ({ solidityFrameWork, quickStart }) =>
const getQuickStart = ({
solidityFramework,
networkConfigPath,
contractsPath,
scriptsPath,
testCommand,
}) => `## Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

1. Install dependencies if it was skipped in CLI:

\`\`\`
cd my-dapp-example
yarn install
\`\`\`

${
Boolean(solidityFramework[0])
technophile-04 marked this conversation as resolved.
Show resolved Hide resolved
? `2. Run a local network in the first terminal:

\`\`\`
yarn chain
\`\`\`

This command starts a local Ethereum network using ${solidityFramework[0]}. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in ${networkConfigPath[0]}.

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 ${contractsPath[0]} and can be modified to suit your needs. The \`yarn deploy\` command uses the deploy script located in ${scriptsPath[0]} to deploy the contract to the network. You can also customize the deploy script.

4. On a third terminal, start your NextJS app:`
: "2. 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\`.
${
Boolean(solidityFramework[0])
? `
Run smart contract test with ${testCommand[0]}

- Edit your smart contract \`YourContract.sol\` in ${contractsPath[0]}
- 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 ${scriptsPath[0]}
`
: ""
}`;

const contents = ({
solidityFramework,
networkConfigPath,
contractsPath,
scriptsPath,
testCommand,
}) =>
`# 🏗 Scaffold-ETH 2

<h4 align="center">
Expand All @@ -11,10 +73,10 @@ const contents = ({ solidityFrameWork, quickStart }) =>
🧪 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, ${
Boolean(solidityFrameWork[0]) ? solidityFrameWork[0] + ", " : ""
Boolean(solidityFramework[0]) ? solidityFramework[0] + ", " : ""
}Wagmi, Viem, and Typescript.
${
Boolean(solidityFrameWork[0])
Boolean(solidityFramework[0])
? "\n- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it."
: ""
}
Expand All @@ -33,8 +95,13 @@ Before you begin, you need to install the following tools:
- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
- [Git](https://git-scm.com/downloads)

${quickStart[0]}

${getQuickStart({
solidityFramework,
networkConfigPath,
contractsPath,
scriptsPath,
testCommand,
})}
## Documentation

Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2.
Expand All @@ -48,23 +115,9 @@ 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.`;

export default withDefaults(contents, {
solidityFrameWork: "",
quickStart: `## Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

1. Install dependencies if it was skipped in CLI:

\`\`\`
cd my-dapp-example
yarn install
\`\`\`

2. 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\`.`,
solidityFramework: "",
networkConfigPath: "",
contractsPath: "",
scriptsPath: "",
testCommand: "",
});
47 changes: 5 additions & 42 deletions templates/extensions/foundry/README.md.args.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,5 @@
export const quickStart = `## Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

1. Install dependencies if it was skipped in CLI:

\`\`\`
cd my-dapp-example
yarn install
\`\`\`

2. Run a local network in the first terminal:

\`\`\`
yarn chain
\`\`\`

This command starts a local Ethereum network using Foundry. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in \`packages/foundry/foundry.toml\`.

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/foundry/contracts\` and can be modified to suit your needs. The \`yarn deploy\` command uses the deploy script located in \`packages/foundry/script\` 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 \`Debug Contracts\` page. You can tweak the app config in \`packages/nextjs/scaffold.config.ts\`.

Run smart contract test with \`yarn foundry:test\`

- Edit your smart contract \`YourContract.sol\` in \`packages/foundry/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/foundry/script\``;

export const solidityFrameWork = "Foundry";
export const solidityFramework = "Foundry";
export const networkConfigPath = `\`packages/foundry/foundry.toml\``;
export const contractsPath = `\`packages/foundry/contracts\``;
export const scriptsPath = `\`packages/foundry/script\``;
export const testCommand = `\`yarn foundry:test\``;
47 changes: 5 additions & 42 deletions templates/extensions/hardhat/README.md.args.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,5 @@
export const quickStart = `## Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

1. Install dependencies if it was skipped in CLI:

\`\`\`
cd my-dapp-example
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 \`packages/hardhat/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 \`Debug Contracts\` page. 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 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\``;

export const solidityFrameWork = "Hardhat";
export const solidityFramework = "Hardhat";
export const networkConfigPath = `\`packages/hardhat/hardhat.config.ts\``;
export const contractsPath = `\`packages/hardhat/contracts\``;
export const scriptsPath = `\`packages/hardhat/deploy\``;
export const testCommand = `\`yarn hardhat:test\``;