Skip to content

rhshah/vFlank-webapp

Repository files navigation

vflank-webapp

CI License: Apache 2.0

A single-page web front-end for vflank — paste, upload, or type a handful of variants and get back masked ddPCR target sequences (and optional Primer3 input), with no install and no patient data leaving the browser.

  • Editable grid (type · paste-from-Excel · upload-populates) with live, vflank-authoritative validation before you run.
  • No-download: reference comes from the UCSC API and population frequencies from gnomAD — there is no BAM and no PHI in this tool (modes A/B only).
  • A thin FastAPI service over vflank.run_small / run_fusion; all the science lives in vflank (this repo is UI + hosting policy).

Scope: single variant / tiny batch (≤10 records). For bulk, fusions with BAM consensus, or offline use, use the vflank CLI / PyPI package.

Demo

Small variant Fusion
Small-variant walkthrough Fusion walkthrough

Paste a variant, press Run, and get the masked flanking sequence (small variant) or chimeric junction (fusion) to download. Full narrated walkthroughs are on the vflank docs — Web tool page.

Run locally

pip install -e ".[dev]"
uvicorn app.main:app --reload
# open http://127.0.0.1:8000

Deploy

Deploy to Render

The button above provisions a free Render web service from the render.yaml blueprint (Python runtime: pip install .uvicorn app.main:app, health check /healthz). After the initial setup, pushes to main redeploy automatically. A Dockerfile is also provided for container parity / other hosts.

Docs

For the science (masking modes, gnomAD AF semantics, coordinate conventions, the run_small API), see the vflank docs — this repo does not duplicate them.

License

Apache-2.0, matching vflank.

About

A single-page web front-end for vflank — paste, upload, or type a handful of variants and get back masked ddPCR target sequences (and optional Primer3 input), with no install and no patient data leaving the browser.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors