From 4c3ffbd941934641b41b3ceffef4bf4b8b14dd5d Mon Sep 17 00:00:00 2001 From: Shravan Date: Sat, 23 Oct 2021 07:41:18 -0400 Subject: [PATCH] Update README.md --- README.md | 87 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 08307e228..57e576572 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,36 @@ -# ๐Ÿ— Scaffold-ETH Typescript +# ๐Ÿ— Scaffold-Eth Typescript + ## Typescript -This is the typescript branch of scaffold.eth. The directories that you'll use are: -``` -packages/vite-app/ -packages/hardhat/ + +This is the typescript repo of scaffold.eth. The directories that you'll use are: + +```bash +packages/vite-app-ts/ +packages/hardhat-ts/ ``` -All the typescript yarn commands have a postfix of `` See the quick start section for more details + +## Quick Start + +Running the app + +1. install your dependencies + + ```bash + yarn install + ``` + +2. start a hardhat node + + ```bash + yarn chain + ``` + +3. run the app, `you'll need to open a new command prompt` + + ```bash + yarn deploy + yarn start + ``` ## Overview @@ -15,13 +40,10 @@ All the typescript yarn commands have a postfix of `` See the quick start sectio ![image](https://user-images.githubusercontent.com/2653167/124158108-c14ca380-da56-11eb-967e-69cde37ca8eb.png) - - -# ๐Ÿ„โ€โ™‚๏ธ Quick Start +# ๐Ÿ„โ€โ™‚๏ธ Building on scaffold-eth-typescript Prerequisites: [Node](https://nodejs.org/en/download/) plus [Yarn](https://classic.yarnpkg.com/en/docs/install/) and [Git](https://git-scm.com/downloads) - > clone/fork ๐Ÿ— scaffold-eth: ```bash @@ -31,7 +53,6 @@ git clone https://github.com/austintgriffith/scaffold-eth.git > install and start your ๐Ÿ‘ทโ€ Hardhat chain: ```bash -cd scaffold-eth yarn install yarn chain ``` @@ -39,14 +60,12 @@ yarn chain > in a second terminal window, start your ๐Ÿ“ฑ frontend: ```bash -cd scaffold-eth yarn start ``` > in a third terminal window, ๐Ÿ›ฐ deploy your contract: ```bash -cd scaffold-eth yarn deploy ``` @@ -68,14 +87,14 @@ Documentation, tutorials, challenges, and many more resources, visit: [docs.scaf ๐Ÿ“š Go through each topic from [solidity by example](https://solidity-by-example.org) editing `YourContract.sol` in **๐Ÿ— scaffold-eth** -- [Primitive Data Types](https://solidity-by-example.org/primitives/) -- [Mappings](https://solidity-by-example.org/mapping/) -- [Structs](https://solidity-by-example.org/structs/) -- [Modifiers](https://solidity-by-example.org/function-modifier/) -- [Events](https://solidity-by-example.org/events/) -- [Inheritance](https://solidity-by-example.org/inheritance/) -- [Payable](https://solidity-by-example.org/payable/) -- [Fallback](https://solidity-by-example.org/fallback/) +- [Primitive Data Types](https://solidity-by-example.org/primitives/) +- [Mappings](https://solidity-by-example.org/mapping/) +- [Structs](https://solidity-by-example.org/structs/) +- [Modifiers](https://solidity-by-example.org/function-modifier/) +- [Events](https://solidity-by-example.org/events/) +- [Inheritance](https://solidity-by-example.org/inheritance/) +- [Payable](https://solidity-by-example.org/payable/) +- [Fallback](https://solidity-by-example.org/fallback/) ๐Ÿ“ง Learn the [Solidity globals and units](https://solidity.readthedocs.io/en/v0.6.6/units-and-global-variables.html) @@ -83,20 +102,18 @@ Documentation, tutorials, challenges, and many more resources, visit: [docs.scaf Check out all the [active branches](https://github.com/austintgriffith/scaffold-eth/branches/active), [open issues](https://github.com/austintgriffith/scaffold-eth/issues), and join/fund the ๐Ÿฐ [BuidlGuidl](https://BuidlGuidl.com)! - - - ๐Ÿšค [Follow the full Ethereum Speed Run](https://medium.com/@austin_48503/%EF%B8%8Fethereum-dev-speed-run-bd72bcba6a4c) - - - - ๐ŸŽŸ [Create your first NFT](https://github.com/austintgriffith/scaffold-eth/tree/simple-nft-example) - - ๐Ÿฅฉ [Build a staking smart contract](https://github.com/austintgriffith/scaffold-eth/tree/challenge-1-decentralized-staking) - - ๐Ÿต [Deploy a token and vendor](https://github.com/austintgriffith/scaffold-eth/tree/challenge-2-token-vendor) - - ๐ŸŽซ [Extend the NFT example to make a "buyer mints" marketplace](https://github.com/austintgriffith/scaffold-eth/tree/buyer-mints-nft) - - ๐ŸŽฒ [Learn about commit/reveal](https://github.com/austintgriffith/scaffold-eth/tree/commit-reveal-with-frontend) - - โœ๏ธ [Learn how ecrecover works](https://github.com/austintgriffith/scaffold-eth/tree/signature-recover) - - ๐Ÿ‘ฉโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ง [Build a multi-sig that uses off-chain signatures](https://github.com/austintgriffith/scaffold-eth/tree/meta-multi-sig) - - โณ [Extend the multi-sig to stream ETH](https://github.com/austintgriffith/scaffold-eth/tree/streaming-meta-multi-sig) - - โš–๏ธ [Learn how a simple DEX works](https://medium.com/@austin_48503/%EF%B8%8F-minimum-viable-exchange-d84f30bd0c90) - - ๐Ÿฆ [Ape into learning!](https://github.com/austintgriffith/scaffold-eth/tree/aave-ape) +- ๐Ÿšค [Follow the full Ethereum Speed Run](https://medium.com/@austin_48503/%EF%B8%8Fethereum-dev-speed-run-bd72bcba6a4c) + +- ๐ŸŽŸ [Create your first NFT](https://github.com/austintgriffith/scaffold-eth/tree/simple-nft-example) +- ๐Ÿฅฉ [Build a staking smart contract](https://github.com/austintgriffith/scaffold-eth/tree/challenge-1-decentralized-staking) +- ๐Ÿต [Deploy a token and vendor](https://github.com/austintgriffith/scaffold-eth/tree/challenge-2-token-vendor) +- ๐ŸŽซ [Extend the NFT example to make a "buyer mints" marketplace](https://github.com/austintgriffith/scaffold-eth/tree/buyer-mints-nft) +- ๐ŸŽฒ [Learn about commit/reveal](https://github.com/austintgriffith/scaffold-eth/tree/commit-reveal-with-frontend) +- โœ๏ธ [Learn how ecrecover works](https://github.com/austintgriffith/scaffold-eth/tree/signature-recover) +- ๐Ÿ‘ฉโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ง [Build a multi-sig that uses off-chain signatures](https://github.com/austintgriffith/scaffold-eth/tree/meta-multi-sig) +- โณ [Extend the multi-sig to stream ETH](https://github.com/austintgriffith/scaffold-eth/tree/streaming-meta-multi-sig) +- โš–๏ธ [Learn how a simple DEX works](https://medium.com/@austin_48503/%EF%B8%8F-minimum-viable-exchange-d84f30bd0c90) +- ๐Ÿฆ [Ape into learning!](https://github.com/austintgriffith/scaffold-eth/tree/aave-ape) # ๐Ÿ’ฌ Support Chat