Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
TalhaFaisalglor committed Aug 2, 2024
2 parents fcc68c2 + a08af12 commit 360aaab
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 3 deletions.
9 changes: 7 additions & 2 deletions src/pages/_data/navigation/mainNav.json5
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,19 @@
]
},
{
"title": "Development Theatre",
"title": "Recommended: Development Theatre",
"url": "/getting-started/development-theatre/",
"children": []
},
{
"title": "Manually Install Development Theatre",
"title": "Manual: Install Development Theatre",
"url": "/getting-started/manual-install/",
"children": []
},
{
"title": "CLI Only: Install Spruce CLI",
"url": "/getting-started/install-cli/",
"children": []
}
]
},
Expand Down
35 changes: 35 additions & 0 deletions src/pages/getting-started/install-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Install the Spruce CLI

This is the fastest way to get up and running with the Spruce CLI. It's the best way to get started in writing regression proof node modules.

1. Install <a href="https://nodejs.org/en/">latest LTS Node</a>.
3. Install <a href="https://code.visualstudio.com">Visual Studio Code (vscode)</a>.
4. Setup <a href="https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line">vscode to work through command line</a>.
5. Quit vscode (**very important or vscode won't get new settings**)

## Install Yarn

```bash
npm install -g yarn
```

## Install Spruce CLI

Once Node, Yarn, and vscode are ready, run the following: 👇

```bash
yarn global add @sprucelabs/spruce-cli
```

### Something Missing?

<div class="grid-buttons">
<a class="btn" href="https://forms.gle/2ZMtwUxg1egV8sHT8">Request Documentation Enhancement</a>
</div>

## Now What?

<div class="grid-buttons">
<a class="btn" href="{{ '/ideology/' | url }}">Learn the Spruce Ideology</a>
</div>

50 changes: 49 additions & 1 deletion src/pages/training/katas/katas.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,54 @@
# Katas🥋

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

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>


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">
<a href="{{ '/training/building-a-skill/' | url }}" class="section-link">
<span class="section-number">Views</span>
</a>
<a href="{{ '/training/katas/' | url }}" class="section-link">
<span class="section-number">Events</span>
</a>
</div>

### Something Missing?

Expand Down

0 comments on commit 360aaab

Please sign in to comment.