janice

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2024 License: MIT Imports: 7 Imported by: 0

README

Janice

A desktop app for viewing large JSON files.

GitHub Release build status GitHub License

Contents

Description

Janice is a desktop app for viewing large JSON files. It's key features are:

  • Browse through a JSON document in classic tree structure
  • JSON files can be opened via file dialog, from clipboard, dropped on the window or given as command line argument
  • Supports viewing very large JSON files (>100MB, >10M elements)
  • Search for keys and values in the document. Supports wildcards.
  • Export parts of a JSON file into a new file or to clipboard
  • Copy values to clipboard
  • Single executable file, no installation required
  • Desktop app that runs on Windows, Linux and macOS (experimental)
  • Automatic dark and light mode

Screenshots

screenshot

How to run

To run Janice just download and unzip the latest release to your computer. Janice ships as a single executable file that can be executed directly. You find the latest packages for download on the releases page.

Linux

[!NOTE] The app is shipped in the AppImage format, so it can be used without requiring installation and run on many different Linux distributions.

  1. Download the latest AppImage file from the releases page and make it executable.
  2. Execute it to start the app.

[!TIP] Should you get the following error: AppImages require FUSE to run., you need to first install FUSE on your system. Thi s is a library required by all AppImages to function. Please see this page for details.

Windows
  1. Download the windows zip file from the latest release on Github.
  2. Unzip the file into a directory of your choice and run the .exe file to start the app.
Mac OS

[!NOTE] The MAC version is currently experimental only, since we have not been able to verify that the release process actually works. We would very much appreciate any feedback on wether the package works or what needs to be improved.

  1. Download the darwin zip file from the latest release on Github.
  2. Unzip the file into a directory of your choice
  3. Run the .app file to start the app.
Build and run from repository

If your system is configured to build Fyne apps, you can build and run this app directly from the repository with the following command:

go run github.com/ErikKalkoken/janice@latest

For more information on how to configure your system for Fyne please see: Getting Started.

FAQ

What is the largest JSON file that I can load?

The largest JSON file you can load on your computer depends mainly on how much RAM you have and on the particular JSON file. The main driver for memory consumption is the number of elements in a JSON document.

For comparison we did a load test on one of our developer notebooks. It has 8 GB RAM and runs Ubuntu 22.04 LTS. We were able to load a JSON files successfully with up to 45 million elements. The size of our test file was about 2.5 GB.

Attributions

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
github
package github contains features for accessing repos on Github.
package github contains features for accessing repos on Github.
jsondocument
Package jsondocument contains the logic for rendering a Fyne tree from a JSON document.
Package jsondocument contains the logic for rendering a Fyne tree from a JSON document.
ui
Package ui contains the user interface.
Package ui contains the user interface.
tools
generate_json
This is a tool for generating large JSON files with random content for testing.
This is a tool for generating large JSON files with random content for testing.
multiply_json
This is a tool for generating large JSON files by multiplying an existing json document
This is a tool for generating large JSON files by multiplying an existing json document

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL