README.md 1.47 KB
Newer Older
Sascha Herzinger's avatar
Sascha Herzinger committed
1
[![Build Status](https://git-r3lab.uni.lu/sascha.herzinger/fractal.js/badges/master/build.svg)](https://git-r3lab.uni.lu/sascha.herzinger/fractal.js/builds/)
Sascha Herzinger's avatar
Sascha Herzinger committed
2

3
### About
Sascha Herzinger's avatar
Sascha Herzinger committed
4
This is the front-end component of the Fractalis project. It is responsible for the communication with the back-end and the visualisation of analysis results. See https://fractalis.lcsb.uni.lu/
5

6 7 8
### Demo
Please have a look at this playlist to see a demo of the visual aspects of Fractalis: [Playlist](https://www.youtube.com/playlist?list=PLNvp9GB9uBmH1NNAf-qTyj_jN2aCPISFU).

9
### Installation
10 11 12 13 14
- Install npm
- Run `npm install` within the project to install all dependencies.
- Run `npm run-script devserver`, which will run a local web server to serve the project to you.
- Open the shown URL and navigate to the test charts in 'test/charts' to play around or do your own development.
- Please note that the test charts might not always be up-to-date. They are really just playground for developers and work-in-progress charts.
15

16
### I don't use webpack or similar tools. How can I include Fractalis in my project?
Sascha Herzinger's avatar
Sascha Herzinger committed
17
https://unpkg.com/fractalis/lib/fractal.js
18 19 20 21 22 23 24

### Usage
Please refer to the [main.js file](https://git-r3lab.uni.lu/Fractalis/fractal.js/blob/master/src/main.js). It is the only file directly exposed to your code.
Basically you initialize a FractalisJS instance by calling the init method and subsequently use the available methods listed in this file to control front and back-end.

### Citation
Manuscript is in preparation.