Create a course

Start from the kata starter and edit its files in your own editor.

1. Start from the starter

git clone https://github.com/dojofoo/starter-kata.git my-course
cd my-course

It's a working TypeScript course with three katas. Keep its layout and replace its lessons.

2. Make it yours

  • dojo.yaml – set name, description and the list of katas. Remove marketplace: false (the older spelling of private: true) when you want it listed. See the kata manifest.
  • DOJO.md and each kata's SENSEI.md – what the sensei teaches from. See teaching notes.
  • Each kata's solution.ts – the starting point the learner edits; solution.test.ts – the behavior that counts as done. Test behavior, not one particular implementation.
  • mise.toml – the tools the course needs and its setup task.

3. Try it as a learner

From a separate folder, install your local copy:

mkdir ../try-my-course && cd ../try-my-course
npx dojofoo install
npx dojofoo add ../my-course

Then run npx dojofoo. Check that the briefing gives a clear first step, that failing tests point somewhere useful, and that finishing leads somewhere.

After you change the course, run npx dojofoo add ../my-course --force in the trial folder to pick up the changes.

4. Publish

Push it to a public GitHub repository – see Publish a course.

Edit on GitHub