jsoncrack.com/README.md

70 lines
2.8 KiB
Markdown
Raw Normal View History

2022-07-31 10:55:37 +03:00
<center>
2022-04-17 10:52:31 +03:00
<a href="https://jsonvisio.com">
2022-07-31 10:55:37 +03:00
<img width="1080" alt="jsonvisio" src="https://user-images.githubusercontent.com/47941171/182015412-f048058e-6e31-4cf6-bcfc-ab9ba3f6e005.png">
2022-04-17 10:52:31 +03:00
</a>
2022-07-31 10:55:37 +03:00
</center>
2022-04-06 14:30:54 +03:00
2022-07-31 10:55:37 +03:00
<p>
2022-04-17 10:52:31 +03:00
<p align="center">
2022-07-31 10:55:37 +03:00
<img alt="travis ci badge" src="https://img.shields.io/travis/com/AykutSarac/jsonvisio.com/main?style=flat-square" />
2022-04-17 10:52:31 +03:00
<a href="https://github.com/AykutSarac/jsonvisio.com/blob/main/LICENSE">
2022-07-31 10:55:37 +03:00
<img alt="license badge" src="https://img.shields.io/github/license/AykutSarac/jsonvisio.com?style=flat-square" />
2022-04-17 10:52:31 +03:00
</a>
<a href="https://github.com/AykutSarac/jsonvisio.com/releases">
2022-07-31 10:55:37 +03:00
<img alt="version badge" src="https://img.shields.io/github/package-json/v/AykutSarac/jsonvisio.com?color=brightgreen&style=flat-square" />
2022-04-17 10:52:31 +03:00
</a>
2022-07-31 10:55:37 +03:00
<a href="https://github.com/sponsors/AykutSarac">
<img alt="github sponsors" src="https://img.shields.io/github/sponsors/AykutSarac?style=flat-square" />
2022-05-07 22:43:05 +03:00
</a>
2022-04-17 10:52:31 +03:00
</p>
<p align="center">
<i>Simple json visualization tool for your data.</i>
2022-07-31 10:55:37 +03:00
<p align="center">
<a href="https://www.producthunt.com/posts/json-visio?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-json&#0045;visio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=332281&theme=light" alt="JSON&#0032;Visio - Simple&#0032;visualization&#0032;tool&#0032;for&#0032;your&#0032;JSON&#0032;data&#0046; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
</p>
2022-04-17 10:52:31 +03:00
</p>
<p align="center">
2022-08-09 16:57:10 +03:00
<img width="800" src="/public/jsonvisio-screenshot.webp" alt="preview 1" />
2022-04-17 10:52:31 +03:00
</p>
2022-07-31 10:55:37 +03:00
2022-01-30 13:09:56 +03:00
2022-04-17 13:38:50 +03:00
# JSON Visio (jsonvisio.com)
2022-07-31 11:08:55 +03:00
JSON Visio is a tool that generates graph diagrams from JSON objects. These diagrams are much easier to navigate than the textual format and to make it even more convenient, the tool also allows you to search the nodes. Additionally, the generated diagrams can also be downloaded or clipboard as image.
2022-04-17 13:38:22 +03:00
2022-07-31 11:08:55 +03:00
You can use the web version at [jsonvisio.com](https://jsonvisio.com) or also run it locally as [Docker container](https://github.com/AykutSarac/jsonvisio.com#-docker).
2022-04-06 14:30:54 +03:00
2022-04-20 15:11:51 +03:00
> <b><a href="https://jsonvisio.com">JSON Visio - Directly onto graphs</a></b>
2022-04-06 14:30:54 +03:00
## ⚡️ Features
2022-04-16 12:48:47 +03:00
* Search Nodes
2022-07-31 11:12:38 +03:00
* Share links & Create Embed Widgets
* Download/Clipboard as image
* Upload JSON locally or fetch from URL
* Great UI/UX
2022-04-16 12:48:47 +03:00
* Light/Dark Mode
2022-07-31 11:12:38 +03:00
* Advanced Error Message
2022-04-06 14:30:54 +03:00
2022-01-30 13:09:56 +03:00
2022-04-17 10:52:31 +03:00
## 🛠 Development Setup
2022-04-30 13:56:06 +03:00
```console
2022-04-26 14:21:56 +03:00
npm install --legacy-peer-deps
2022-04-17 10:52:31 +03:00
npm run dev
```
2022-04-30 13:56:06 +03:00
## 🐳 Docker
```
A Docker file is provided in the root of the repository.
If you want to run JSON Visio locally:
* Build Docker image with `docker build -t jsonvisio .`
2022-08-16 17:41:23 +03:00
* Run locally with `docker run -p 8888:8080 jsonvisio`
2022-04-30 13:56:06 +03:00
* Go to [http://localhost:8888]
```
2022-04-17 10:52:31 +03:00
2022-04-06 14:30:54 +03:00
## License
2022-02-04 18:57:26 +03:00
2022-04-06 14:30:54 +03:00
This project is open source and available under the [MIT License](LICENSE).