jsoncrack.com README

The project's README from github.com/AykutSarac/jsoncrack.com. As one markdown file: README.md.

Logo

JSON Crack

The open-source JSON Editor.
Learn more »

ToDiagram · Discord · Website · Issues · VS Code · Chrome

About the Project

JSON Crack editor

Visualize JSON into interactive graphs

JSON Crack is a tool for visualizing JSON data in a structured, interactive graphs, making it easier to explore, format, and validate JSON. It offers features like converting JSON to other formats (CSV, YAML), generating JSON Schema, executing queries, and exporting visualizations as images. Designed for both readability and usability.

Recognition

Featured on Hacker News

JSON Crack | Product Hunt

Integrations

Contributing

Sponsors & Support

If you find JSON Crack useful, you can support the project by using ToDiagram. For sponsorship inquiries, reach out at [email protected].

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.

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, read the LICENSE for additional details.

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

  2. Go to the project folder

    cd jsoncrack.com

  3. Install packages

    pnpm install

  4. Run the web app

    pnpm dev:www

# Running on http://localhost:3000/

Useful Commands

From repository root:

# Web app
pnpm dev:www
pnpm build:www

# VS Code extension
pnpm dev:vscode
pnpm build:vscode
pnpm lint:vscode
pnpm lint:fix:vscode

# Chrome extension
pnpm dev:chrome
pnpm build:chrome
pnpm lint:chrome

# All workspaces
pnpm dev
pnpm build
pnpm lint

Debug VS Code Extension

  1. Open repository root in VS Code.
  2. Press F5.
  3. Select Run VSCode Extension (apps/vscode) when prompted.
  4. In the Extension Development Host window, open a .json file and run: JSON Crack: Enable JSON Crack visualization.

Docker

🐳 Docker assets are in apps/www. If you want to run JSON Crack locally:

cd apps/www

# Build a Docker image with:
docker compose build

# Run locally with docker compose
docker compose up

# Go to http://localhost:8888

Configuration

The supported node limit can be changed by editing NEXT_PUBLIC_NODE_LIMIT in apps/www/.env.

License

See LICENSE for more information.

jsoncrack.com (AykutSarac/jsoncrack.com)

chrome-extension
Searching Database…

44.5K ·GitHub
Jsoncrack.com
What is this?JSON Crack is an open-source tool that visualizes JSON, YAML, XML and CSV data as interactive graphs or trees, making it easier to explore, format, and validate structured data.
Is this a web app, or can I use it as an extension too?It is mainly a web app (built with Next.js), but the same visualizer is also packaged as a VS Code extension, a Chrome extension, and an npm package.
How do I run it myself instead of using the hosted site?Clone the repo, go into the project folder, install packages with pnpm, then run the web app; there's also a `turbo run dev --filter=www` command and Docker assets under apps/www for local hosting.
What do I need installed before building it?Node.js version 24 or higher and pnpm version 10 or higher.
Is there a limit on how large a JSON file I can visualize?Yes, there's a configurable node limit for graphs, controlled by the NEXT_PUBLIC_NODE_LIMIT environment variable in apps/www/.env.
Does my data get uploaded anywhere when I visualize it?No, all processing happens locally in your browser/app; nothing is stored on their servers.
Can it convert between formats, like JSON to CSV?Yes, it can seamlessly transform data between formats, e.g. JSON to CSV or XML to JSON, for easy sharing.
Can it generate code from my JSON?Yes, it generates TypeScript interfaces, Golang structs, Kotlin data classes, Rust serde types, and JSON Schema from your data.
Can I export the graph as an image?Yes, you can download your visualization as PNG, JPEG, or SVG.
Does it support advanced querying of the data?Yes, it has advanced tools to run jq and JSON path queries directly on your data.
What are similar projects?xyflow, beautiful-mermaid, git-history, keywordpro, gitdiagram, jsonhero-web, smart-excalidraw-next, G6
Which topics is it in?diagrams, validation, csv, graph, vscode-extension, npm-package, yaml, chrome-extension, browser-extension, visualization, data-visualization, nextjs
Creator
AykutSarac
Size
41 MB
Stars
44.5K
Updated
CommitSep 14Releasev5.0.0Mar 11
Age
4y
Commits · 90 Days