Skip to content

MathisBurger/testlytic

Repository files navigation

testlytic


An modern looking websocket testing client


Project Information

Testlytic is a project I built, because I was unable to find a good-looking, fast and functional websocket test-client. Therefore, I started to create my own one. It is a react app wrapped into an electron app. This is the reason, why there is also an online version running on github pages.

Installation

If you want to use the desktop. client you can download the latest installer from the releases tab.

If you want to host the client yourself through the docker container follow these steps:

  1. Pull the docker image from the registry
docker pull ghcr.io/mathisburger/testlytic
  1. Start the container
docker run -d -p 3000:3000 ghcr.io/mathisburger/testlytic
  1. You can access your local installation now on your browser under http://localhost:3000

Contributing

If you want to contribute to the project check out the CONTRIBUTING.md. It contains all information you need for contributing to the testlytic project. Generally everyone can contribute to the project. You just have to follow some development guidelines to leave the codebase as clean as possible.

Local development setup

If you want to setup the project for development follow these steps:

  1. Clone the code from the repository
git clone github.com/mathisburger/testlytic
  1. install yarn
npm install -g yarn
  1. go into the project folder
cd testlytic
  1. install packages
yarn install
  1. run the webapp to check, if it works
yarn react-start --open