-
Notifications
You must be signed in to change notification settings - Fork 13
Getting Started
Since its creation, Multi-Experiment Viewer was designed to be open source from the ground up. Because of this, we encourage support from users in maintaining the existing codebase and generating new features. Along with this, we utilize open source libraries so savvy engineers can easily contribute to the application as a whole.
To contribute, have a handle in coding using javascript, and be ready to use these libraries to design, test, and add your contributions to our project.
We use D3.js for all of our visualization needs. This standard javascript library is well known in the industry of data visualization, and has a strong user group. Your visualizations should use this library. Find out more about D3.js here.
Effeckt has been a great way to add custom effects to our css, but this is mostly for user experience and not recommended to be changed or used for visualizations. If you would like to add something using Effeckt, send a pull request and explain which css files you utilize. Find out more about Effeckt here.
As one of the internet's most used css libraries, its hard not to include Twitter's Bootstrap in our library. You'll notice the organizational layout abilities provided by bootstrap make it easy to have responsive positioning of your visualizations and options. Find out more about Bootstrap here.
A front-end framework is a requirement for any serious application, and choosing Angular for its comprehensive library that seamlessly merges html and javascript was a no brainer. Use Angular to control data flow and user experience quickly and easily when building new pages for MEV. Find out more about Angularjs here.
Designing front end requires comprehensive testing in multiple browsers, and the integration of Karma testing is essential for any addition to the front end of MEV. Find out more about Karma Test Runner here.
An application powered by a strong software management suite makes developing and managing project dependencies and testing easy. It is not recommended to add additional code to our backend, but if you feel your visualization requires it, send a pull request and let us know why. Find out more about Apache Maven here.
Commenting your commits is essential to maintaining a clean and well documented code base. If your code addresses a specific issue, bug, or request, use the Github Markdown and specify exactly what it fixes. Also be sure to explain your pull request further so others can understand exactly what your code does.
Along with this, please send all pull requests into a new branch, as we utilize a master-hotfix-dev-issue style of version control. If your pull-request is accepted, it will become a new issue branch to be added to our development branch and released in our next iteration.