Skip to content

Latest commit

 

History

History
155 lines (104 loc) · 5.01 KB

README.md

File metadata and controls

155 lines (104 loc) · 5.01 KB
Raw

Logo

JSON Crack (formerly JSON Visio)

The open-source JSON Editor.
Learn more »

Discord · Website · Issues · VS Code

About the Project

booking-screen

More Than a JSON Editor

JSON Crack is a free, open-source data visualization app capable of visualizing data formats such as JSON, YAML, XML, CSV and more, into interactive graphs. With its intuitive and user-friendly interface, JSON Crack makes it easy to explore, analyze, and understand even the most complex data structures. Whether you're a developer working on a large-scale project or a data enthusiast looking to uncover hidden insights, JSON Crack has the tools and features you need to unlock the full potential of your data.

  • Dark mode.
  • Graph & Tree view modes.
  • Transform & filter data with AI.
  • Export to PNG, SVG, JPEG & clipboard.
  • Zoom and panning support with touch gestures.
  • Supports data formats like JSON, YAML, CSV, XML, TOML...
  • JQ, JSON Schema, Decode JWT, Generate Types and interfaces.
  • Wide range of tools - search graph, json path, validate, save to cloud...
  • Embeddable iframe widgets.

Recognition

Featured on Hacker News

JSON Crack | Product Hunt

Built With

Stay Up-to-Date

JSON Crack officially launched as v1.0 on the 17th of February 2022 and we've come a long way so far. Watch releases of this repository to be notified of future updates:

Star at GitHub

Getting Started

To get a local copy up and running, please follow these simple steps.

Prerequisites

Here is what you need to be able to run JSON Crack.

  • Node.js (Version: >=18.x)
  • Pnpm (recommended)

Development

Setup

  1. Clone the repo into a public GitHub repository (or fork https://github.com/AykutSarac/jsoncrack.com/fork). If you plan to distribute the code, keep the source code public to comply with GPLv3. To clone in a private repository, acquire a commercial license

    git clone https://github.com/AykutSarac/jsoncrack.com.git

  2. Go to the project folder

    cd jsoncrack.com

  3. Install packages with yarn

    pnpm install

  4. Run the project

    pnpm dev

# Running on http://localhost:3000/

Docker

🐳 A Dockerfile is provided in the root of the repository. If you want to run JSON Crack locally:

# Build a Docker image with:
docker build -t jsoncrack .

# Run locally with `docker run`
docker run -p 8888:8080 jsoncrack

# Run locally with `docker-compose`
docker-compose up -d

# Go to http://localhost:8888

Contributing

Please see our contributing guide.

Good First Issues

We have a list of help wanted that contain small features and bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Contributors

License

Distributed under the GPLv3 License. See LICENSE for more information.