|
1 |
| -# Readme for challenge base |
| 1 | +# 🚩 Challenge {challengeNum}: {challengeEmoji} {challengeTitle} |
| 2 | + |
| 3 | +{challengeHeroImage} |
| 4 | + |
| 5 | +A {challengeDescription}. |
| 6 | + |
| 7 | +🌟 The final deliverable is an app that {challengeDeliverable}. |
| 8 | +Deploy your contracts to a testnet then build and upload your app to a public web server. Submit the url on [SpeedRunStark.com](https://speedrunstark.com/)! |
| 9 | + |
| 10 | +💬 Meet other builders working on this challenge and get help in the {challengeTelegramLink} |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Checkpoint 0: 📦 Environment 📚 |
| 15 | + |
| 16 | +Before you begin, you need to install the following tools: |
| 17 | + |
| 18 | +- [Node (>= v18.17)](https://nodejs.org/en/download/) |
| 19 | +- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install)) |
| 20 | +- [Git](https://git-scm.com/downloads) |
| 21 | + |
| 22 | +### Compatible versions |
| 23 | + |
| 24 | +- Scarb - v2.5.4 |
| 25 | +- Snforge - v0.25.0 |
| 26 | +- Cairo - v2.5.4 |
| 27 | + |
| 28 | +Make sure you have the compatible versions otherwise refer to [Scaffold-Stark Requirements](https://github.com/Quantum3-Labs/scaffold-stark-2?.tab=readme-ov-file#requirements) |
| 29 | + |
| 30 | +Then download the challenge to your computer and install dependencies by running: |
| 31 | + |
| 32 | +```sh |
| 33 | +git clone https://github.com/Quantum3-Labs/speedrunstark.git --recurse-submodules {challengeName} |
| 34 | +cd {challengeName} |
| 35 | +git checkout {challengeName} |
| 36 | +yarn install |
| 37 | +``` |
| 38 | + |
| 39 | +> in the same terminal, start your local network (a local instance of a blockchain): |
| 40 | +
|
| 41 | +```sh |
| 42 | +yarn chain |
| 43 | +``` |
| 44 | + |
| 45 | +> in a second terminal window, 🛰 deploy your contract (locally): |
| 46 | +
|
| 47 | +```sh |
| 48 | +cd <challenge_folder_name> |
| 49 | +yarn deploy |
| 50 | +``` |
| 51 | + |
| 52 | +> in a third terminal window, start your 📱 frontend: |
| 53 | +
|
| 54 | +```sh |
| 55 | +cd <challenge_folder_name> |
| 56 | +yarn start |
| 57 | +``` |
| 58 | + |
| 59 | +📱 Open http://localhost:3000 to see the app. |
| 60 | + |
| 61 | +> 👩💻 Rerun `yarn deploy --reset` whenever you want to deploy new contracts to the frontend, update your current contracts with changes, or re-deploy it to get a fresh contract address. |
| 62 | +
|
| 63 | +🔏 Now you are ready to edit your smart contract `{YourCollectible.cairo}` in `packages/snfoundry/contracts` |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +### ⚔️ Side Quests |
| 68 | + |
| 69 | +_To finish your README, can add these links_ |
| 70 | + |
| 71 | +> 🏃 Head to your next challenge [here](https://speedrunstark.com/). |
| 72 | +
|
| 73 | +> 💬 Problems, questions, comments on the stack? Post them to the [🏗 Scaffold-Stark developers chat](https://t.me/+wO3PtlRAreo4MDI9) |
0 commit comments