# Bittly

**Repository Path**: moyansen/Bittly

## Basic Information

- **Project Name**: Bittly
- **Description**: Bittly是一个通讯调试工具，支持通讯调试、上位机面板、自动化测试、自动响应
- **Primary Language**: JavaScript
- **License**: GPL-2.0
- **Default Branch**: main
- **Homepage**: https://www.oschina.net/p/bittly
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 18
- **Created**: 2024-02-13
- **Last Updated**: 2024-02-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <a href="https://bittly.sigechen.com"
  ><img src="https://res.bittly.sigechen.com/img/logo.png" alt="Bittly Logo" height="64"/></a>
  <br/>
  <p><h3><b>Bittly</b></h3></p>
  <p><b>A testing tool for serial port, network, bluetooth, http, websocket, ... </b></p>

  [![Website](https://img.shields.io/website?url=https%3A%2F%2Fbittly.sigechen.com)](https://bittly.sigechen.com)
  [![Build](https://github.com/sige5193/bittly/actions/workflows/build-packages.yml/badge.svg)](https://github.com/sige5193/bittly/actions/workflows/build-packages.yml)

  <p>English | <a href="README.zh.md">简体中文</a></p>
  <br>

  <img src="https://res.bittly.sigechen.com/images/bittly-2.gif" alt="Bittly"/>
</div>

# Table of Contents
- [Support](#Support)
- [Features](#Features)
- [Install](#Install)
- [Document](#Document)
- [Developing](#Developing)
- [Contributing](#Contributing)
- [License](#License)

### Support 
[![Bittly QQ GROUP](https://img.shields.io/badge/QQ%20Group-1014521818-blue)](https://qm.qq.com/cgi-bin/qm/qr?k=NqSWCMQAFL5RE-ic1tC8U0Fp5gtc1XwB&jump_from=webapi)
[![Bittly QQ](https://img.shields.io/badge/QQ-568109749-black)](http://wpa.qq.com/msgrd?v=3&uin=568109749&site=qq&menu=yes)
![Wechat](https://img.shields.io/badge/Wechat-sige--5193-brightgreen)
![Email](https://img.shields.io/badge/Email-568109749%40qq.com-infornational)
![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fsige_5193)

### Features

📈 Supported communication types : Serial Port, Network, Bluetooth, HTTP, WebSocket, MQTT and Modbus. 

📂 Save directive content and organize by collections.

🎨 Text, hex, file and form editor to build any kind of parameter contents

🚀 Easy to build complex parameter data with structural form, without any calculator, just input what doc says.

📄 Load parameters from file and send content line by line, or bytes by bytes.

🎩 Environment variables, script variables and quick calls make it more powerfully to build dynamic parameters.

📊 Stream, hex, text, structural formatter and plotter to show response more analysable.

📚 Export response data to bin, text and excel files.

🚦 Bind directive on widgets to build a ui controll panel by draging and droping without any code.

🍡 Button, slider, text input, slect, map, plotter, inidactor, timer and more widgets are suppported in panel.

🖥️ Log viewer and variable manager to monitoring panel executing.

✔️ Create testcases for directive with different parameter value and execute testcase to keep directive response available.

📜 Generate project document from directive definations to pdf or markdown file.

🌎 I18n: Experience the app in your language. (You can make a pull requests to help us to translate bittly) .

⏳ and more ...

### Install
1. Download it from [https://bittly.sigechen.com/download](https://bittly.sigechen.com/download) 
2. Execute the installer program or unzip the zip file.
3. Click `Bittly` and start to using it. 

### Document

You can find document here [https://bittly.sigechen.com/manual](https://bittly.sigechen.com/manual)

### Developing

1. Setup nodejs environment
2. Clone this repo with git `git clone https://github.com/sige5193/bittly.git`
3. Install dependencies by npm `npm install`
4. Start dev server by `npm run electron:serve`
5. Run unit test by `npm run test:unit`
6. Build app package by `npm run electron:build`

### Contributing

Please contribute using [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), create a branch, commit and open a pull request.

### License

This project is licensed under the GPL-2.0 - see the `LICENSE` file for details.