Skip to content

tadast/json-api-document-viewer

Repository files navigation

{json:api} document viewer.

The flat {json:api} structure is a good way to express complex, sometimes circular relationships between objects in your API responses. However the same flatness makes it difficult for humans to "parse" these relationships. This project aims to visualise object relationships by visually nesting them.

This is a very much work in progress project: it lacks some essential features and has some crucial bugs.

Built using React Starterify.

Usage

Clone this project git clone https://github.com/tadast/json-api-document-viewer.git && cd json-api-document-viewer

Install the dependencies:

npm install

Test:

npm test

Development mode with livereload:

npm run watch or just npm start

When you are done, create a production ready version of the JS bundle:

npm run build

Deploy on Github pages with one command:

npm run deploy

License

MIT License