⛩️ INSTALLATION GUIDELINE ⛩️

[jimenezz22]

⛩️ Dojo By Example Quick Start Guide ⛩️

This guide will help you set up the project in just 5 minutes.

Prerequisites

Install Dojo version 1.1.0. If you don't have this version installed, you can run the following command, which is a dev suite that installs asdf, scarb, and dojo in specific versions and sets them as global on your system:

curl -s https://raw.githubusercontent.com/KaizeNodeLabs/starkiro/main/cli/install_dojo_dev_suit.sh -o install_dojo_dev_suit.sh
bash install_dojo_dev_suit.sh --scarb 2.9.2 --dojo 1.1.0

This command was developed by Starkiro. This is a collection of educational scripts built using the Cairo programming language. It is ideal for both beginners and intermediate developers looking to deepen their understanding of Cairo and Starknet concepts.

Once the dev suite is installed, you are all set to start contributing.

Compilation and Testing

Once your issue is ready, you must ensure that it compiles and that the tests pass. To do this, run:

sozo build

This command compiles the code.

sozo test

This command runs the tests.

If both commands pass successfully, congratulations! Your code is ready to be submitted in a PR and reviewed by the maintainers.