Skip to content

Get Started: GitHub Codespaces

Peter Thomas edited this page Jun 6, 2023 · 15 revisions

The official Visual Studio Code extension for Karate has excellent support for GitHub Codespaces.

You don't need to install anything locally, and everything works remotely, just within your browser. You need a GitHub account and be logged in.

Open Existing GitHub project

You can use this as an example: karate-test (or see below for a simpler template).

Click on the Code button to bring up the Codespaces dialog where you can create a new Codespace.

image

Or you can choose a simpler "template" project which is this one: karate-template

image

Install Official Karate Extension

Once the project has opened in your browser, switch to the Extensions explorer and type in karate in the search box. Make sure you select the official Karate extension from Karate Labs where the logo is in the shape of a circle.

Refer to the screenshot below.

image

Run Karate Test

Yes, getting up and running with Karate on GitHub Codespaces is that simple - with just a few clicks in your browser !

Now you can open (or create) any Karate *.feature file and run it by clicking on the Run >> "CodeLens" that appears at the top of the file.

image

Video

You can watch this video showing how to run a test from within the IDE: Karate in GitHub Codespaces