Local development environment for IGV.js + htsget-rs

Production htsget-rs servers can be deployed to several cloud providers via htsget-deploy, however a local dev environment that bypasses CORS for convenience is very useful.

WARNING: Never use this environment in production, this is only meant for localhost-only debugging and development.

Quickstart

Assuming you have docker-(compose) installed on your local machine, run this one time one liner:

git clone --recursive https://github.com/umccr/htsget-igv.js && \
cd htsget-igv.js && \
(cd igv.js && npm install)

Tilt up the docker containers:

docker compose up

Open the browser:

open http://localhost:8787/dev/htsget/htsget.html

If all goes well, you should see the following:

Browser config

Even if CORS is effectively disabled at the server level in this configuration's repo (see compose.yml's environment directive for details), some browsers will required a bit of settings tweaking, namely:

Firefox

Will work right away :D

Please report if that's not the case for you?

Safari

Will currently not work due to restrictions around the use of 0.0.0.0.

Brave

Will only work if its implicit Ad-blocking system is disabled as shown below.