https://github.com/qaware/dev-tool-kit

https://github.com/qaware/dev-tool-kit

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/qaware/dev-tool-kit
• Owner: qaware
• License: mit
• Created: 2021-04-22T07:54:01.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T00:23:21.000Z (almost 2 years ago)
• Last Synced: 2024-08-10T18:05:51.080Z (6 months ago)
• Language: Go
• Size: 2.06 MB
• Stars: 48
• Watchers: 7
• Forks: 12
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# DevToolKit

[![Build status](https://github.com/qaware/dev-tool-kit/actions/workflows/build.yml/badge.svg)](https://github.com/qaware/dev-tool-kit/actions/workflows/build.yml)

![Go version 1.16 required](https://img.shields.io/github/go-mod/go-version/qaware/dev-tool-kit)

This repository contains a desktop application with many useful tools for software developers.

It is written in Go using [Wails](http://wails.app/) for providing a multi-platform GUI.

![](screenshot.png)

## Usage

### Tools

All the tools are organized in tabs. You can click on your button of choice or press `Ctrl+f` to search for a tool.

Among others, the following tools are included:

* Base64 encoding

* Hex editor

* HTTP client

* JSON and XML pretty printing

* JWT decoding

* Port scanner

### Customization

You can add a custom tab to the DevToolKit. Create a new file called `pages.xml` in the same directory as the executable.

Here is an example for a simple HTML page with just a single link:

```XML

    

        MyTool

        My cool tool

        This is my cool new tool.

        fa-tools

        

            QAware

        

    

```

Here, `` must be a unique name, `` is the button label, `` is the text for the button tooltip,

 `` is the [Font Awesome](https://fontawesome.com/v5.14.0/icons?d=gallery&m=free) icon,

and `` is the HTML source of the page.

### Errors

In case of a crash, a stack trace is written to the file `panic.txt` in the same directory as the executable. If you raise a bug report, please attach the content of this file.

## Development

### Install Wails

See https://wails.app/gettingstarted/ to learn how to setup Wails on your platform.

### Build locally

Checkout the code and run `make build-debug` to quickly build a development version with debug logging enabled. The artifact will appear in `build/`.

### Release

Change the version number in the file `main.go` and create a tag consisting of a `v` as prefix and the same version number.

Push the tag to the repository and thus trigger the GitHub actions that will automatically create a new release.

After that, the installed DevToolKits from all the users will update to that new version.