/starklings

An interactive tutorial to get you up and running with Starknet

Primary LanguagePython

Starklings

An interactive tutorial to get you up and running with Starknet


Installation

Clone the repository to your local machine:

git clone --branch stable --single-branch https://github.com/onlydustxyz/starklings.git

Then install the tool, run:

curl -L https://raw.githubusercontent.com/onlydustxyz/starklings/master/install.sh | bash

Usage

Run the tool in watch mode in the repository and follow the instructions:

cd PATH_TO_THE_CLONED_REPO
starklings --watch

To verify an exercise without the watch mode run:

starklings --verify relative_path_to_the_exercise_file

To display one solution to a given exercise run:

starklings --solution relative_path_to_the_exercise_file

Update

The tool is in continuous evolution. You might want to update it regularly.

git pull
bash install.sh

Inspiration

  • Protostar for all the project tooling and setup, deployment, packaging
  • Rustlings for the amazing pedagogy and brilliant concept of progressive and interactive tutorial

Contributing

See CONTRIBUTING.md.