README

<a href="https://jsoncrack.com"><strong>Learn more »</strong></a>




<a href="https://todiagram.com">ToDiagram</a>
·
<a href="https://discord.gg/yVyTtCRueq">Discord</a>
·
<a href="https://jsoncrack.com">Website</a>
·
<a href="https://github.com/AykutSarac/jsoncrack.com/issues">Issues</a>
·
<a href="https://marketplace.visualstudio.com/items?itemName=AykutSarac.jsoncrack-vscode">VS Code</a>

About the Project

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.

• Visualizer: Instantly convert JSON, YAML, CSV, and XML into interactive graphs or trees in dark or light mode.
• Convert: Seamlessly transform data formats, like JSON to CSV or XML to JSON, for easy sharing.
• Format & Validate: Beautify and validate JSON, YAML, and CSV for clear and accurate data.
• Code Generation: Generate TypeScript interfaces, Golang structs, and JSON Schema.
• JSON Schema: Create JSON Schema, mock data, and validate various data formats.
• Advanced Tools: Decode JWT, randomize data, and run jq or JSON path queries.
• Export Image: Download your visualization as PNG, JPEG, or SVG.
• Privacy: All data processing is local; nothing is stored on our servers.

Recognition

<a href="https://producthunt.com/posts/JSON-Crack?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-jsoncrack" target="_blank"></a>

Integrations

• VS Code Extension
• npm Package (jsoncrack-react)

Contributing

• Found a bug or missing feature? Open an issue on GitHub Issues.
• Want to contribute code or docs? Start with our contribution guide.

Sponsors & Support

If you find JSON Crack useful, you can support the project by using ToDiagram.

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:

<a href="https://github.com/AykutSarac/jsoncrack.com"></a>

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: >=24.x)
• pnpm (Version: >=10)

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.

   shCopy

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

2. Go to the project folder

   shCopy

   cd jsoncrack.com
   

3. Install packages

   shCopy

   pnpm install
   

4. Run the web app

   shCopy

   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

# All workspaces
pnpm dev
pnpm build
pnpm lint

pnpm build:www is the production build command used in GitHub Actions deployment.

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.