README.md

💠 scaffold-stark

scaffold-stark is a forkable StarkNet dev stack focused on fast product iterations, inspired by scaffold-eth.

Drop in your Cairo smart contracts and immediately compile, deploy and interact with them through a reusable frontend UI.

Link to the product demo.

Requirements:

• Node.js
• Python venv
• Yarn
• Git

Setup / Installation

1. Clone / fork 💠 scaffold-stark:

https://github.com/parketh/scaffold-stark

2. Run venv and install packages:

python3 -m venv cairo_venv
source cairo_venv/bin/activate
pip install -r requirements.txt

3. Install JS packages with yarn:

yarn install

4. Start starknet-devnet in first terminal window while running cairo_venv (http://localhost:5050)

starknet-devnet

5. Start local server in second terminal window - used to handle RPC calls (http://localhost:3001)

yarn server

6. Start frontend app in third terminal window (http://localhost:3000)

yarn dev

7. Edit your smart contracts in the contracts/ folder and compile them with starknet-compile (see docs)

npx hardhat starknet-compile [PATH...]

8. Open http://localhost:3000 to see the app. Add custom frontend as you wish (Next.js + TailwindCSS).