Skip to content

Commit

Permalink
Update README to add a Guide to create New Challenges (#9)
Browse files Browse the repository at this point in the history
* Update base template README with guide and hints to create new challenges

* README tweaks and add TODO questions

* Remove initial hints (will move it main)

---------

Co-authored-by: Carlos Sánchez <oceanrdn@gmail.com>
  • Loading branch information
Pabl0cks and carletex authored Jul 12, 2023
1 parent 1f83e18 commit 54678b3
Showing 1 changed file with 33 additions and 15 deletions.
48 changes: 33 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# 🚩 Challenge {challengeNum}: {challengeEmoji} {challengeTitle}

{challengeHeroImage}

A {challengeDescription}.

🌟 The final deliverable is an app that {challengeDeliverable}.
Deploy your contracts to a testnet then build and upload your app to a public web server. Submit the url on [SpeedRunEthereum.com](https://speedrunethereum.com)!

💬 Meet other builders working on this challenge and get help in the {challengeTelegramLink}

---

## Checkpoint 0: 📦 Install 📚

Before you begin, you need to install the following tools:
Expand All @@ -24,28 +28,42 @@ git checkout {challengeName}
yarn install
```

> in the same terminal, start your local network (a blockchain emulator in your computer):
🔏 Edit your smart contract {smartContractFileName} in `packages/hardhat/contracts`

```sh
yarn chain
```
---

> in a second terminal window, 🛰 deploy your contract (locally):
## Checkpoint 1: 🔭 Environment 📺

```sh
cd {challengeName}
yarn deploy
You'll have three terminals up for:

```bash
yarn start (Next app frontend)
yarn chain (hardhat backend)
yarn deploy (to compile, deploy, and publish your contracts to the frontend)
```

> in a third terminal window, start your 📱 frontend:
> 💻 View your frontend at http://localhost:3000/
```sh
cd {challengeName}
yarn start
```
> 👩‍💻 Rerun `yarn deploy --reset` whenever you want to deploy new contracts to the frontend.
---

_Other commonly used Checkpoints (check one Challenge and adapt the texts for your own):_

## Checkpoint {num}: 💾 Deploy it! 🛰

## Checkpoint {num}: 🚢 Ship it! 🚁

📱 Open http://localhost:3000 to see the app.
## Checkpoint {num}: 📜 Contract Verification

## Checkpoint {num}: Create all the required Checkpoints for the challenge
---

_Create all the required Checkpoints for the Challenge, can also add Side Quests you think may be interesting to complete. Check other Challenges for inspiration._

## ⚔️ Side Quests

_To finish your README, can add these links_

> 🏃 Head to your next challenge [here](https://speedrunethereum.com).
> 💬 Problems, questions, comments on the stack? Post them to the [🏗 scaffold-eth developers chat](https://t.me/joinchat/F7nCRK3kI93PoCOk)

0 comments on commit 54678b3

Please sign in to comment.