GETTING_STARTED.md

Getting Started with Slow Code kata in Typescript

Prerequisites

• macOS, Linux or Windows

• git client

• curl command line utility

• Node

• Yarn

  Details

  You can install node directly or through nvm.

Getting ready

1 - Clone the kata repository

git clone https://github.com/philou/Kata-Slow-Code.git

2 - Go to the kata's typescript directory

cd Kata-Slow-Code/typescript

3 - Download dependencies

yarn install

Running the kata

You can run the kata from the command line or from your IDE of choice.

You may also run it using TCR if you want to add a bit of spice.

• From a terminal with Yarn
• From a terminal with TCR

Running the kata from a terminal with Yarn

Reminder: the command below should be run from Kata-Slow-Code/typescript directory

The kata comes with a Yarn test target pre-configured. Just type the following to run it.

yarn test

Running the kata from a terminal with TCR

Note to Windows users

Use a git bash terminal for running the command below. Windows CMD and PowerShell are not supported

Type the following to start TCR:

./tcrw

Refer to Using TCR section for additional details about TCR and available options.

Using TCR

Cheat Sheet

Here are the main shortcuts available once TCR utility is running:

Shortcut	Description
?	List available options
d / D	Enter driver role (from main menu)
n / N	Enter navigator role (from main menu)
q / Q	Quit current role - Quit TCR (from main menu)
t / T	Query timer status (from driver role only)
p / P	Toggle on/off git auto-push (from main menu)

Additional Details

Refer to TCR - Test && Commit || Revert page for additional details and explanations about TCR utility.