From 6f02846f10b32f1c0cc98fa369a809c3a6b5d385 Mon Sep 17 00:00:00 2001 From: Taylor Romero Date: Fri, 2 Aug 2024 08:56:00 -0600 Subject: [PATCH 1/4] minor: cli only install --- src/pages/_data/navigation/mainNav.json5 | 9 ++++-- src/pages/getting-started/install-cli.md | 35 ++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 src/pages/getting-started/install-cli.md diff --git a/src/pages/_data/navigation/mainNav.json5 b/src/pages/_data/navigation/mainNav.json5 index cad4f861..13c25025 100644 --- a/src/pages/_data/navigation/mainNav.json5 +++ b/src/pages/_data/navigation/mainNav.json5 @@ -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": [] } ] }, diff --git a/src/pages/getting-started/install-cli.md b/src/pages/getting-started/install-cli.md new file mode 100644 index 00000000..74461945 --- /dev/null +++ b/src/pages/getting-started/install-cli.md @@ -0,0 +1,35 @@ +# Install the Spruce CLI + +This is the fastest way to get up and running with the Spruce CLI. This is a great way to get started in writing regression proof node modules. + +1. Install latest LTS Node. +3. Install Visual Studio Code (vscode). +4. Setup vscode to work through command line. +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? + +
+ Request Documentation Enhancement +
+ +## Now What? + +
+ Learn the Spruce Ideology +
+ From 2d39291abf7c71d4bb100d67fefc812b424a0d5c Mon Sep 17 00:00:00 2001 From: Taylor Romero Date: Fri, 2 Aug 2024 08:59:28 -0600 Subject: [PATCH 2/4] patch: tweak --- src/pages/getting-started/install-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/getting-started/install-cli.md b/src/pages/getting-started/install-cli.md index 74461945..ac9bc323 100644 --- a/src/pages/getting-started/install-cli.md +++ b/src/pages/getting-started/install-cli.md @@ -1,6 +1,6 @@ # Install the Spruce CLI -This is the fastest way to get up and running with the Spruce CLI. This is a great way to get started in writing regression proof node modules. +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 latest LTS Node. 3. Install Visual Studio Code (vscode). From f727d29ba416f631bb732d8e2484c471476f351b Mon Sep 17 00:00:00 2001 From: Taylor Romero Date: Fri, 2 Aug 2024 09:08:44 -0600 Subject: [PATCH 3/4] patch: progress --- src/pages/training/katas/katas.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/src/pages/training/katas/katas.md b/src/pages/training/katas/katas.md index 79aaec50..403fb022 100644 --- a/src/pages/training/katas/katas.md +++ b/src/pages/training/katas/katas.md @@ -1,6 +1,28 @@ # Katas🥋 -Coming soon... +There are two paths you can take. + +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. + +## 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 + +``` + +## Spruce Katas + +
+ + Views + + + Events + +
### Something Missing? From a08af12b2c0b6341595f2f080e122927029731b3 Mon Sep 17 00:00:00 2001 From: Taylor Romero Date: Fri, 2 Aug 2024 09:21:36 -0600 Subject: [PATCH 4/4] minor: test docs --- src/pages/training/katas/katas.md | 34 +++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/src/pages/training/katas/katas.md b/src/pages/training/katas/katas.md index 403fb022..297a6663 100644 --- a/src/pages/training/katas/katas.md +++ b/src/pages/training/katas/katas.md @@ -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 + +
+1. Create your project -## 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". + +
+
+2. Create your first test + +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`. + +
+ ## Spruce Katas