Skip to content

Latest commit

 

History

History
102 lines (69 loc) · 4.22 KB

README.md

File metadata and controls

102 lines (69 loc) · 4.22 KB
Raw

Overview

JSorolla is a JavaScript library for biological and genomic data visualization.

Documentation

You can find JSorolla documentation and tutorials at: http://docs.opencb.org/display/jsorolla/JSorolla+Home.

Issue Tracking

You can report bugs or request new features at GitHub issue tracking.

Release Notes and Roadmap

Releases notes are available at GitHub releases.

Roadmap is available at GitHub milestones. You can report bugs or request new features at GitHub issue tracking.

Versioning

JSorolla is versioned following the rules from Semantic versioning.

Maintainers

The main developers and maintainers are:

Former Contributors
Contributing

JSorolla is an open-source and collaborative project. We appreciate any help and feedback from users, you can contribute in many different ways such as simple bug reporting and feature request. Depending on your skills you are more than welcome to develop client tools, new features or even fixing bugs.

How to build

JSorolla is developed in JavaScript 6 (es6) and makes a heavy usage of all the new features. It uses npm as building tool.

Stable releases are merged and tagged at master branch, you are encourage to use latest stable release for production. Current active development is carried out at develop branch, only building is guaranteed to work and bugs are expected, use this branch for development or for testing new functionalities.

Prerequisites

The following technologies are needed to build JSorolla: Node.js and its package manager npm.

Installing Node.js and npm

To install Node.js you can visit this link.

npm stands for node packaged modules and it is the dependency manager of Node.js.

Cloning

JSorolla is an open-source and free project, you can download develop branch by executing:

$ git clone https://github.com/opencb/jsorolla.git
Cloning into 'jsorolla'...
remote: Counting objects: 36760, done.
remote: Compressing objects: 100% (149/149), done.
remote: Total 36760 (delta 162), reused 135 (delta 76), pack-reused 36532
Receiving objects: 100% (36760/36760), 27.46 MiB | 1.60 MiB/s, done.
Resolving deltas: 100% (27029/27029), done.
Checking connectivity... done.

To fetch the latest stable release at master branch can be downloaded executing:

$ git clone -b master https://github.com/opencb/jsorolla.git
Cloning into 'jsorolla'...
remote: Counting objects: 36760, done.
remote: Compressing objects: 100% (149/149), done.
remote: Total 36760 (delta 162), reused 135 (delta 76), pack-reused 36532
Receiving objects: 100% (36760/36760), 27.46 MiB | 2.01 MiB/s, done.
Resolving deltas: 100% (27029/27029), done.
Checking connectivity... done.

Build

After installing Node.js and npm we have to install all npm dependencies of JSorolla, from the the root folder execute:

npm install

This will make npm to search all dependencies at file package.json and install them locally.

You can build all JSorolla demos by executing:

npm run build

when completed, all demos will be located under the build folder.

Finally, you can build JSorolla libs by executing:

npm run dist

when completed, all compiled files will be located under the dist folder.

Testing

You can copy build content to a web server such as Apache HTTP Server and open your favourite internet browser to open JSorolla demos.

Supporters

JetBrains is supporting this open source project with:

[Intellij IDEA] (http://www.jetbrains.com/idea/)