Add a "Quick Start" section to the README file

[dtikhonov]

For those who want to run the tool locally instead of relying on a remote web server an ocean away.

[rmarx]

Hello @dtikhonov,

Valid point. Though let me point out that you do not need the full server setup (the separate qvis-server project at https://github.com/quiclog/qvis-server) if you're uploading qlog files directly. The server is only needed if you want to load .pcap files or load qlog files from a non-CORS enabled URL.

If you just want to install the qvis tools locally (so just manually uploading qlogs), the following steps should do:

curl -sL https://deb.nodesource.com/setup_10.x | bash -
    && apt-get install -y nodejs

git clone --depth 1 https://github.com/rmarx/qvis.git /srv/qvis
  && cd /srv/qvis/visualizations
  && npm install
  && npm run serve

# the serve command sets up a local debugging server at port :8080 which should allow you to reach the tools

If you do want to use the full setup, you can look at the docker files at:
https://github.com/quiclog/qvis-server/tree/master/system/docker_setup
and some helpful scripts to get that rolling at:
https://github.com/quiclog/qvis-server/tree/master/system/server_config/control

I will keep this issue open to remind that I need to add a similar guide to the README at some point. Thanks for the reminder.

[marten-seemann]

@rmarx Have you considered rolling out a Docker container? Then all that people would have to do is a docker run qvis:latest -p 80:80?

By the way, it's super easy to build a Docker image in CI and upload it to DockerHub automatically. Take a look at my shiny new config I'm using in quic-go: https://github.com/lucas-clemente/quic-go/blob/master/.github/workflows/build-interop-docker.yml.