k6-example
A starter template for writing k6 performance tests in TypeScript using Vite bundler.
Overview
This project provides a ready-to-use template for creating k6 performance tests written in TypeScript. It simplifies the setup process by using Vite as a bundler and includes examples that work with a publicly available API endpoint, allowing developers to immediately test and understand k6's capabilities.
Key Features
- TypeScript Support — Write k6 tests with full TypeScript type safety and modern JavaScript features.
- Vite Bundler Integration — Uses Vite (Rollup) for fast and efficient bundling of test scripts.
- Real-time Monitoring — Includes setup for xk6-dashboard extension to visualize performance tests in real time.
- Public API Examples — Comes with sample tests using the reqres.in REST API for immediate testing without backend setup.
- Pre-configured Scripts — Provides yarn scripts for running tests with and without monitoring capabilities.
- Docker Support — Includes Docker instructions for easy setup of the xk6-dashboard extension.
Philosophy
The template emphasizes simplicity and immediate usability, allowing developers to focus on writing performance tests rather than configuration. It leverages modern tooling to create a smooth development experience for k6 testing.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
