public

Web application for demonstration and testing of the backend.

File system layout

• readme.md: the main documentation file
• src/: source code of the application

Third-party components:

• lib/: manually installed
• bower_components/: installed through Bower

Versioning

To ignore:

• 3rd party libraries:
  • lib/
  • bower_components/

Resources

3rd party libraries

I always use the latest releases except specified otherwise.

• modules management
  • Require.js
• standard/basic library
  • JQuery
• GUI
  • Bootstrap 3
  • Hogan.js: templating
• code edition
  • Ace
  • CodeMirror
• introspection
  • code highlighting
    • Highlight.js
  • tree display
    • jqTree
  • graph display
    • JavaScript InfoVis Toolkit
    • Cytoscape.js

Contribute

Setup

Considering the files have already been cloned from the repository, the only thing you need to do is to install the third party libraries.

For that, we are currently using Bower, please install it.

Once installed, run this command in this current folder:

bower install

Try

Just go to the root of the backend project and follow the instructions to launch the backend.

The application is served on two routes:

• / (no path)
• /app

Open a browser and connect to localhost, on the port specified in the backend options (default to 3000): http://localhost:3000

Backlog

Issues

• static locations specified in the options of the server are served considering the current working directory, which is a too weak convention (might change easily): change the use of the server library by specifying explicitly a root, resolved from a deterministic property (like the path of the module file)

Documentation

• Write documentration

Code

JIT

Implement a graph display using JavaScript InfoVis Toolkit.

Cytoscape

Improve the use of the Cytoscape library.

• Adapt width of nodes to its content
• Add scrolling features, more convenient than moving (by selecting all or pressing an edge) and playing with zoom
• See how to choose the children orientation with the current layout (from left to right instead of right to left - for now the order is reversed on server-side to fix that)

Bootstrap

Maybe find an alternative.

What is missing now:

• easy layout management