Contributing

Somethings to Know

Alchemy uses yeoman to manage workflow...

More Philosophy

Since Alchemy is an application and not a library, all elements are added dynamically. Things like filters, search, tags, etc. are added inserted dynamically if the users specifies in their configuration file. This is a further attempt to create the lowest possible barrier to entry. Default styles for these elements can easily be overridden.

If you want to add your own HTML elements, you can easily do so. Take a look at the functions for the default element you are replacing and easily call them from your the correct scope.

About Application Scopes

Application scopes are intiated in the init.coffee file.

Currently Alchemy contains the following application scopes:
app: main controllers that handle data and generate visualization
layout: main functions that control the layout of the nodes and edges - e.g. charge, and link strength
interactions: all of the functions for user interaction with the graph - e.g. node click, dbl click, etc.
utils: all helpers - e.g. resizing the svg when the window is resized - the purpose of this scope is not yet well defined...
More scopes - TBD

TODO: Develop node and edge models to be used as factories that can be tested.