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.

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

[DOCS] Add tutorial on installing starknet-devnet with asdf #65

Merged
merged 9 commits into from
Dec 19, 2024
56 changes: 56 additions & 0 deletions docs/quick-start/starknet-devnet-with-asdf.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Starknet Devnet - Installation with asdf

This document provides a guide to install **Starknet Devnet** using `asdf`, a Rust-based tool for developers. Below, you'll find instructions for installation using `asdf`.

## Requirements

- **asdf**: Install `asdf` by following the [official asdf documentation](https://asdf-vm.com/).

## Installation Using `asdf`

1. **Add the Starknet Devnet plugin**:

```bash
asdf plugin add starknet-devnet
```

2. **List all available versions**:

```bash
asdf list-all starknet-devnet
```

3. **Install the latest version**:

```bash
asdf install starknet-devnet latest
```

Alternatively, to install a specific version, such as `0.2.3`, use:

```bash
asdf install starknet-devnet 0.2.3
```

cidkagenow marked this conversation as resolved.
Show resolved Hide resolved
⚠️**WARNING:**
cidkagenow marked this conversation as resolved.
Show resolved Hide resolved

> **Remenber the latest compatible version with scaffold is 0.2.3**.
cidkagenow marked this conversation as resolved.
Show resolved Hide resolved

4. **Set the installed version as global or local**:
```bash
asdf global starknet-devnet 0.2.3
# or
asdf local starknet-devnet 0.2.3
```

## Additional Resources

- [Starknet Official Documentation](https://starknet.io/docs)
- [Starknet Devnet GitHub Repository](https://github.com/0xSpaceShard/starknet-devnet-rs)
- [Starknet Devnet versions](https://github.com/0xSpaceShard/starknet-devnet-rs/tags)

## Troubleshooting

If you encounter any issues during installation or execution, consider the following:

- Ensure you have the latest version of `asdf` installed.
Loading