Skip to main content

​
Getting started with LearnPack as a creator

There are two ways to use LearnPack: as a creator of interactive tutorials, or as a learner consuming those tutorials. This guide focuses on the creator path.
Prerequisites: Make sure you have Node.js installed, then install the LearnPack CLI. Find the package on npm: @learnpack/learnpack.

​
Start your first tutorial

Follow these steps to create a tutorial project.
1

Install the CLI globally

Run:
npm install -g @learnpack/learnpack
2

Initialize the project

In an empty folder, run:
learnpack init
The wizard will ask about your tutorial’s configuration and then scaffold the project.
3

Answer the setup questions

You will be prompted for:
  • Grading type (see options below)
  • Title of the tutorial
  • Description
  • Difficulty (Beginner, Easy, Intermediate, Hard)
  • Estimated duration (hours)

​
Grading types at a glance

OptionWhat it meansWhen to use
IncrementalYou cannot move forward until the current exercise passes its tests. Later steps depend on earlier knowledge.Progressive skill-building paths.
IsolatedEach exercise is independent. You can jump to any step in any order.Drill practice or non-linear study.
No gradingNo tests for exercises.Reading tasks, demos, or exploratory content.
Grading selector
Tip: Not sure about duration yet? Keep the default and adjust later while you iterate content.

​
Project structure

After the wizard finishes, your tutorial files are created in a new directory: Directory files Each exercise you add should follow the same basic structure:
  • README.md: the learner-facing instructions.
  • Test file: used if the tutorial is graded.
  • Entry file (e.g., app.py / app.js): the code the learner edits.
    The default filename can be overridden in configuration.
Add one folder per exercise and keep the structure consistent.

​
What to do next

Once your project is scaffolded, start adding exercises and tests, then run LearnPack locally to preview the flow.

​
See also