Skip to content

skeleton with some ready to use testing libs to quick start TDD kata sessions

License

Notifications You must be signed in to change notification settings

christian-draeger/kata-setup

Repository files navigation

🚀 TDD-kata-setup Actions Status

This is a template project with some ready to use testing setup to quick start TDD kata sessions...

hacken

Origin of the word Kata explained. Kata (Japanese: 形, or more traditionally, 型; lit. “form”) is a Japanese word describing detailed patterns of movements practiced either solo or in pairs.[1] Karate kata are executed as a specified series of a variety of moves, with stepping and turning, while attempting to maintain perfect form. Traditionally, kata are taught in stages. Previously learned kata are repeated to show better technique or power as a student acquires knowledge and experience. It is common for students testing to repeat every kata they have learned but at an improved level of quality. As an reference to this practices you can train yourself doing Test-Driven-Development in a Karate Katas fashion.

This project includes working setups and examples for:


Prerequisites

  • JDK >= 8 installed

👨‍🍳 How-To:

📁 get the project

There are multiple ways to get the setup running on your mashine. You can either:

  • use the Template if you want to create a completely new repository

    or

  • Fork the project

    or

  • download it as Zip file.

💫 Run all tests

./gradlew check

📰 Choose a Kata

Pick a Kata you want to master and start TDD'ing ♻️


👌 Recommended

  • gdub installed
    • ℹ️ gdub (gw on the command line) invokes ./gradlew on projects where a gradle wrapper is configured, and falls back to use the gradle from the $PATH if a wrapper is not available.

🔧 Troubleshooting

☕️ install JDK11 via sdkman:
$ curl -s "https://get.sdkman.io" | bash
$ source "$HOME/.sdkman/bin/sdkman-init.sh"
$ sdk i java 11.0.4.hs-adpt
🚧 using intelliJ and modern JS derivatives (fix syntax highlighting for ES6 and TS):
  1. open Intellij preferences (on mac ⌘,)
  2. goto Languages & Frameworks
  3. choose JavaScript
  4. select JavaScript language version: ECMAScript 6

🤝 Contributions Welcome

If you're having some nice Katas or further ideas regarding the template/test setup feel free to send pull requests :neckbeard: