Giter VIP home page Giter VIP logo

json-preview's Introduction

json-preview logo

JSON Preview

Convert JSON files to downloadable diagrams

Overview

A web application which allows a user to easily visualize any JSON file and generate diagrams from it.

Live Preview: https://json-preview.vercel.app

Tools and Packages Used

  • React
  • prismjs
  • react-component-export-image
  • react-simple-code-editor
  • reactflow
  • sass

Features

  • Tabs
  • Preview Board
  • Code editor
  • Zoom In/out
  • Focus control
  • Lock
  • Download Button

Why I started this project

I came across a code editor that helps you visualize JSON file, so I thought about build something similar as a web app with additional features.

I had a challenges with generating the diagram, but Reactflow gave me insight on how to connect the different nodes and edges together.

How It Works

Users can easily interact with the code editor and type in JSON structured code.

The code editor has a debugging feature - red indicator that shows error exist in the code. Thus, It can't be previewed until it is fixed.

At the bottom-left, it has features which allows:

  • Zoom in or out from the workspace.
  • Fit to view for easy switching on the vertical or horizontal direction.
  • Lock to restrict the diagram generated from further edit or distortion.

At the top-right, there is:

  • Download to the diagrams
  • Orientation adjustment button for custom view.

The left side menu consists of:

  • Eraser to delete the contents in the code editor.
  • Social media handles (Linkedin, Twitter)
  • Github repository

Installation

  1. Clone the repository
git clone https://github.com/ugwustanley/json-preview.git
  1. Change the working directory
cd json-preview
  1. Install dependencies
npm install
  1. Run the app
npm start

You can now see it at http://localhost:3000 in your browser.

Contributing

If you face any problems while using the application, please open an issue or submit a pull request.

Support

Please give this project a star⭐, if you like it.

License

This project is built under the MIT License.

json-preview's People

Contributors

frankiefab100 avatar ugwustanley avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

json-preview's Issues

Can't handle null value

 {
    "name": "json-preview",
    "version": "0.1.0",
    "private": null
}

^ Put that in the code editor, select the "preview board" tab, and it falls over - screen goes blank

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.