The main goal of this project is to create a system able to provide answers to specific biological research questions around the data acumulated from different experiments and annotations.
The questions or use cases will be defined previous to the development, in this way we garantee that the platform, once completely developed is able to satisfy real needs of the community.
The master branch will contain horizontal functionalities that are common to all the use cases. Please create a new brach for each new use case you pretend to solve within the system. As an example the branch [Variant annotations] (../../tree/variant-annotation) will hold the developments around the genomic variant annotation functionality.
Please use the wiki pages to add new use cases, one per page. Please document the use case as much as possible before to start asking for pull requests.
- Download [Elasticsearch] (https://www.elasticsearch.org/overview/elkdownloads/) and extract the content in a folder
Then run
./bin/elasticsearch
- Download and install [NodeJs] (https://nodejs.org/)
(If you have installed NodeJs by hand, remember to add its bin subdirectory to the PATH environment variable)
- Download and install [Grunt] (https://gruntjs.com/), using next:
npm install -g grunt-cli
As this command tries to write in the NodeJs installation directory, if NodeJs was installed as a system package, then this step should be run with more privileges. Alternatively you can run
npm install grunt-cli
and add ${HOME}/node_modules/.bin to the PATH environment variable.
- Download and install [Bower] (https://bower.io/), using next:
npm install -g bower
As this command tries to write in the NodeJs installation directory, if NodeJs was installed as a system package, then this step should be run with more privileges. Alternatively you can run
npm install bower
and add ${HOME}/node_modules/.bin to the PATH environment variable.
- Clone this repository, install the dependencies and execute the
gruntcommand
git clone [email protected]:inab/dataportal.git
cd dataportal
# bower install should have been called by *npm install*
# if asks about d3, choose 2
npm install
# Some package installations could have overwritten something, so
git checkout -- public/lib/angular
# In the future, this command will be replaced by grunt
node server
The application will start on https://localhost:3000