1.0.4 • Published 5 years ago
kafka-topic-viewer v1.0.4
kafka-topic-viewer
CLI program to visualize a Kafka Topic
This repository is currently a WIP
| Typescript | Best-Practive Typescript language configuration |
| Linting | Linting and code style with TSLint |
| Jest | Unit testing and watching with Jest |
| CI | Gitlab CI base configuration for test and coverage integration |
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
Install dependencies for development and environment:
npm installRunning the tests
| Command | Description |
|---|---|
| npm run test | Run all tests |
| npm run test:cov | Run all tests and report coverage |
| npm run test:watch | Run tests based on git differences |
Linting and code style
Please follow linter errors are reported by tslint and fix accordingly when contributing.
Built With
- Typescript - Language
- Jest - Testing suite
Versioning
We use SemVer for versioning.
License
This project is licensed under the Apache 2.0 license - see the LICENSE.md file for details