Skip to content

Scaffold-Stark/speedrunstark

 
 

Repository files navigation

🚩 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 SpeedRunStark.com!

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


Checkpoint 0: 📦 Environment 📚

Before you begin, you need to install the following tools:

Starknet-devnet version

To ensure the proper functioning of scaffold-stark, your local starknet-devnet version must be 0.4.0. To accomplish this, first check your local starknet-devnet version:

starknet-devnet --version

If your local starknet-devnet version is not 0.4.0, you need to install it.

Compatible versions

  • Cairo - v2.11.4
  • Rpc - v0.8.x
  • Scarb - v2.11.4
  • Snforge - v0.41.0
  • Starknet-Devnet - v0.4.0

Make sure you have the compatible versions otherwise refer to Scaffold-Stark Requirements

Docker Option for Environment Setup

For an alternative to local installations, you can use Docker to set up the environment.

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 install

or clone from SpeedrunStark repo:

git clone https://github.com/Scaffold-Stark/speedrunstark.git {challengeName}
cd {challengeName}
git checkout {challengeName}
yarn install

in the same terminal, start your local network (a local instance of a blockchain):

yarn chain

To 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 deploy

in a third terminal window, start your 📱 frontend:

cd <challenge_folder_name>
yarn start

📱 Open http://localhost:3000 to see the app.

👩‍💻 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.

🔏 Now you are ready to edit your smart contract {YourCollectible.cairo} in packages/snfoundry/contracts


⚔️ Side Quests

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

About

SpeedRunStark challenges logic/codebase (Powered by Scaffold-Stark)

Resources

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.6%
  • JavaScript 1.9%
  • Cairo 1.4%
  • CSS 1.1%