Skip to content

Commit

Permalink
minor: test docs
Browse files Browse the repository at this point in the history
  • Loading branch information
liquidg3 committed Aug 2, 2024
1 parent f727d29 commit a08af12
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions src/pages/training/katas/katas.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,44 @@
# Katas🥋

There are two paths you can take.
There are two paths you can take to hone your skills:

1. You can set yourself up with an empty node module and start writing tests.
2. You can follow one of our Spruce katas to learn the ins and outs of the Spruce Platform.
1. **Node Module**: Set yourself up with an empty node module and start writing tests. This best for when you want to master TDD seperate from the Spruce Platform.
2. **Spruce Kata**: You can follow one of our Spruce katas to learn the ins and outs of the Spruce Platform. This is for when you have the basics of TDD and are ready to learn the Spruce Platform.

## Node Module

<details>
<summary><strong>1. Create your project</strong></summary>

## Empty Node Module

If you want to write a node module from scratch than anyone can use, you can start by running the following command:

```bash
cd path/to/your/projects
spruce create.module kata1
```

> **Note**: Make sure to follow the instructions in the CLI from this point forward.
> **Note**: Along the way, you will be asked if you want to install the "Skill" feature. You can select "Always Skip".
</details>

<details>
<summary><strong>2. Create your first test</strong></summary>

Once you are in your new module, you can open up terminal and run:

```bash
spruce create.test
```

> **Note**: You will be asked if you are making a "Behavioral" or "Implementation" test. You can select "Behavioral" for now.
> **Note**: You will be asked which abstract test to extend, select `AbstractSpruceTest`.
</details>

## Spruce Katas

<div class="guide-sections">
Expand Down

0 comments on commit a08af12

Please sign in to comment.