Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: devnet documentation #94

Merged
merged 2 commits into from
Jun 1, 2024
Merged

chore: devnet documentation #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8784ed8
chore: devnet documentation
od-hunter May 29, 2024
59c3e91
chore: effected requested devnet doc changes
od-hunter May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions docs/src/chapter_6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# Spinning up and using Devnet

An introduction to starknet devnet, and how you can easily spin it up using a script:
## Introduction

Resources:
- https://github.com/argentlabs/Starknet-Scaffold/tree/main?tab=readme-ov-file#run-starknet-devnet
- https://book.starknet.io/ch02-06-starknet-devnet.html
Starknet Devnet is a development network (devnet) implemented in Rust, similar to the Python-based starknet-devnet.With Devnet, you can simulate Starknet in the comfort of your local network. Fork mainnet/testnet to interact with real-world smart contracts, while maintaining isolation.

## Prerequisites:

1. Docker Installation: Docker has to be installed for the script to work.

## Run Starknet-Devnet

Ensure to have Docker installed. To run starknet-devnet:

```
npm run devnet
```

Check out the official starknet devnet documentation [here](https://book.starknet.io/ch02-06-starknet-devnet.html).