Server side image rendering of Cytoscape.js graphs/networks using Node.js and PhantomJS

[abbycabs]

[ Project Lead ] @maxkfranz
[ GitHub Repo ] https://github.com/cytoscape/cytosnap & https://github.com/cytoscape/cytosnap-demo
[ Track ] Tools: you are building a tool others can help you build
[ Level ] Intermediate
[ Timezone ] EDT

Description

Graph theory (a.k.a. network) library for analysis and visualisation : http://js.cytoscape.org. Server side network rendering with Cytoscape.js

This project will build a Node.js package that people can require() in their own projects to generate images of graphs/networks on the server side.

• Input : A Cytoscape graph, represented in JSON, image options (size, quality, ...)
• Output : A PNG or JPG file
• Strategy :
  • Use PhantomJS to run an instance of Cytoscape.js in a page that runs in a headless instance of Webkit
  • Export the image either using a mechanism built into Phantom or as generated by cy.png() or cy.jpg()
  • It may be better to structure the module as a long running service to avoid the cost of spinning up Phantom instances for each image generated
  • Use promises in the API
• Deliverables
  • A reusable package on npm
  • A Docker container with a demo Express server where you can POST graph JSON and get back an image
  • The Docker demo deployed to Nodejitsu to show off this sprint project :)

---

Want to Contribute?

Join us at the Global Sprint June 2-3. Leave a comment in this issue to let the project lead know you're interested in contributing during #mozsprint 2016!

You can chat with us on the repo's Gitter channel.

---

Note to the Project Lead

Congrats, @maxkfranz! This is your official project listing for the Mozilla Science Global Sprint 2016. To confirm your submission, please complete the following:

• Provide a GitHub repository for work and discussion on your project
• Confirm in a comment that at least one person will be available to review and answer questions on this project from 9-5 in their timezone on both June 2 & 3.

[maxkfranz]

@acabunoc Yes, I'll be available

[maxkfranz]

Project : Server side image rendering of Cytoscape.js graphs/networks using Node.js and PhantomJS

Repo : https://github.com/cytoscape/cytosnap

[abbycabs]

Thanks @maxkfranz! Feel free to update the issue with project info :)

[eronisko]

Hi @maxkfranz, is your time zone Eastern Time (UTC-05:00)?

[maxkfranz]

@eronisko Yes