Project intro
NetJSON is a data format based on JSON(What is NetJSON?), and netjsongraph.js(GitHub) is a visualization library for it. This library has attracted quite some interest from around the world, but there are some defects, such as tests and modern build process lacking.
Therefore our goal is to improve the features and development workflow of netjsongraph.js. To be specific:
- make it faster with large numbers
- make it more mobile friendly
- use modern tools that are familiar to JS developers, so they can contribute more easily
- add automated tests so we can be more confident of introducing changes
- get rid of complex features
- make it easy to extend, so users can experiment and build their own derivatives
- make it easy to redraw/update the graph as new data comes in, at least at the library level we should support this
- geographic visualization (like https://ninux.nodeshot.org/ (nodeshot project)
Arrangement
About me
I’m a graduate student from China and also a front-end developer with more than one-year working experience. And now I am interested in the Data Visualization and already made several visualization projects of network structure. So lucky my proposal selected by Freifunk in Google Summer of Code 2017. It’s a great opportunity to participate in a promising open source project. Thanks for my mentor’s guidance and hope I can finish an excellent job. So I listed the following plan:
Tasks and Schedule
- create a new branch: build the project with yarn, Webpack and Babel. 1 week
- To build a (mostly) backward compatible version 1 week
- draw a demo graph using canvas or WebGL. 2 week
- make a example page to show visualization results. 1 week
- add test(using Ava and XO) and CI. 1 week
- discuss and design visualization view 1 week
- import and integrate with OpenStreeMap or Mapbox to make a map. 1 week
- visualization implemention. 8 weeks
- beautify the visualization. 1 weeks
- improve visualization and test. 4 weeks
- design interface for plugin (to make this library extensible) *2 week