https://github.com/adiwg/mdtools
Visualize, validate, and translate ADIwg JSON metadata
https://github.com/adiwg/mdtools
Last synced: 26 days ago
JSON representation
Visualize, validate, and translate ADIwg JSON metadata
- Host: GitHub
- URL: https://github.com/adiwg/mdtools
- Owner: adiwg
- License: unlicense
- Created: 2014-10-29T02:23:38.000Z (over 10 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-20T22:27:34.000Z (5 months ago)
- Last Synced: 2025-03-31T17:43:17.033Z (2 months ago)
- Language: CSS
- Homepage: http://mdtool.adiwg.org
- Size: 1.82 MB
- Stars: 7
- Watchers: 14
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdTools
JavaScript tool for visualizing [json-schemas](http://json-schema.org/), includes validator and support for the [mdTranslator](https://github.com/adiwg/mdTranslator) via the [API](https://api.sciencebase.gov/mdTranslator).
The [live application](http://www.adiwg.org/mdJson-schema-viewer/) is rendering the
[mdJson-schemas](https://github.com/adiwg/mdJson-schemas).
Built using:
- [d3js](http://d3js.org/)
- [jQUery](http://jquery.com/)
- [jQUery Mobile](http://jquerymobile.com/)
- [tv4](http://geraintluff.github.io/tv4/)
- [FileReader.js](http://bgrins.github.io/filereader.js/)
- [highlight.js](https://highlightjs.org/)
- [jsonpointer.js](https://github.com/alexeykuzmin/jsonpointer.js)
- [Grunt HTML Boiler](https://github.com/mhulse/grunt-html-boiler)
- [URI.js](https://github.com/medialize/URI.js)
## Developer Guide
This project uses the command line tool `grunt` to build the production version. At the moment, the dev parts appear to be a little broken but they have not been tested recently.
In order to build and deploy this application you should use the `npm` scripts rather than trying to do anything directly.
### Install and Build
As usual, install npm dependencies first, then build the application.
1. `npm install`
2. `npm run build`
This will build the application into the docs/ directory, ready for production.
### Deploy to GitHub Pages
Use the `npm` script:
`npm run deploy`
### Build and Run with Docker
Build docker:
1. `docker build -t mdtools .`
2. `docker run --rm -d -p 8043:8043 mdtools`