Home

Welcome to the SVIP wiki.

This repo, coordinator, is the entrypoint to SVIP's multi-repo system. The other repos are as follows:

• svip_api, the API server
• frontend, the frontend (a single-page web app written in Vue)
• g2p-aggregator, the pipeline that populates SVIP with variant data from third-party sources

Note that g2p-aggregator is a heavily-modified fork of OHSU's https://github.com/ohsu-comp-bio/g2p-aggregator.

Getting Started

Prerequisites: Docker, docker-compose.

The quickest way to obtain all of SVIP is the following:

git clone --recursive git@github.com:SVIPdb/coordinator.git svip
cd svip
git submodule foreach -q --recursive \
  'git checkout $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo master)'

Once the checkout process has completed, you may run the following to bring up SVIP's database, API server, and frontend:

docker-compose up

After that, browse to http://localhost:3000, where if all went well you should see the SVIP homepage.