{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 SpeedRunStark.com!
💬 Meet other builders working on this challenge and get help in the {challengeTelegramLink}
Before you begin, you need to install the following tools:
- Node (>= v22)
- Yarn (v1 or v2+)
- Git
To ensure the proper functioning of scaffold-stark, your starknet-devnet version must match the version specified in Compatible versions. To accomplish this, first check your starknet-devnet version:
starknet-devnet --versionIf your starknet-devnet version is not the version specified in Compatible versions, you need to install it.
- Install starknet-devnet via
asdf(instructions). Use the exact version from Compatible versions.
- Starknet-devnet - 0.6.1
- Scarb - v2.12.2
- Snforge - v0.51.1
- Cairo - v2.12.2
- Rpc - v0.9.x
Make sure you have the compatible versions otherwise refer to Scaffold-Stark Requirements
Details
For an alternative to local installations, you can use Docker to set up the environment.
- Install Docker and VSCode Dev Containers extension.
- A pre-configured Docker environment is provided via
devcontainer.jsonusing thestarknetfoundation/starknet-devimage with the Scarb version specified in Compatible versions.
For complete instructions on using Docker with the project, check out the Requirements Optional with Docker section in the README for setup details.
Then download the challenge to your computer and install dependencies by running:
npx create-stark@latest -e {challengeName} {challengeName}
cd {challengeName}
yarn installor clone from SpeedrunStark repo:
git clone https://github.com/Scaffold-Stark/speedrunstark.git {challengeName}
cd {challengeName}
git checkout {challengeName}
yarn installin the same terminal, start your local network (a local instance of a blockchain):
yarn chainTo run a fork :
yarn chain --fork-network <URL> [--fork-block <BLOCK_NUMBER>]
in a second terminal window, 🛰 deploy your contract (locally):
cd <challenge_folder_name>
yarn deployin a third terminal window, start your 📱 frontend:
cd <challenge_folder_name>
yarn start📱 Open http://localhost:3000 to see the app.
👩💻 Rerun
yarn deploy --resetwhenever 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.
🔏 Now you are ready to edit your smart contract {YourCollectible.cairo} in packages/snfoundry/contracts
To finish your README, can add these links
🏃 Head to your next challenge here.
💬 Problems, questions, comments on the stack? Post them to the 🏗 Scaffold-Stark developers chat