k6 tutorial

A simple example project to help in getting started with k6. Please refer to the k6 documentation for more information.

With Docker

Prerequisites

• Docker
• Docker Compose

Building

Build the mock API using the following command:

docker-compose build api

Running

Run the mock API with Docker Compose with the following:

docker-compose up -d api

Then run the test with the following command:

docker-compose run --rm k6 run -e BASE_URL=http://api:3000 test/load/api.test.js

Without Docker

Prerequisites

• Node/NPM
• k6

Setup

npm install

Running

Start the mock API with the following:

npm start

Then in a different terminal window, use the following to run the load test:

k6 run test/load/api.test.js