Skip to content

Commit 4ffd098

Browse files
authored
Create README.md
1 parent b0dd833 commit 4ffd098

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
- [Downloading data](#downloading-data)
3838
- [How it works](#how-it-works)
3939
- [Installation](#installation-for-developers)
40-
40+
- [Running the web app locally](#running-the-web-app-locally)
4141

4242
## Usage
4343
> :warning: This tool is intended to be used <strong>only for sequences that cannot be shared publicly</strong>. If you do not have this requirement, please use the [UShER web tool](https://genome.ucsc.edu/cgi-bin/hgPhyloPlace) and submit your sequences to an INSDC member institution (NCBI, EMBL-EBI, or DDBJ) and GISAID
@@ -86,3 +86,29 @@ FASTA to VCF conversion is performed by aligning each provided sample pairwise t
8686

8787
## Installation (for developers)
8888

89+
### Running the web app locally
90+
>SHUShER currently only supports building on Linux systems, and has been tested on Ubuntu 20.04
91+
92+
If you would like to run ShUShER locally, first download the source code, e.g.:
93+
94+
`wget https://github.com/amkram/shusher/archive/refs/tags/v0.1.0.tar.gz`
95+
`tar xvzf v0.1.0.tar.gz`
96+
97+
View all "Releases" in the right sidebar if you want to download a specific version. Alternately, cloning this repository will give you the latest, unreleased code, but may be unstable.
98+
99+
The downloaded source code contains code for building both the web app and the UShER port.
100+
101+
Enter the `web-app` subdirectory and run
102+
103+
`npm install`
104+
105+
To build the app, run
106+
107+
`npm build`
108+
109+
And to start the local server, run
110+
111+
`npm start`
112+
113+
You should now be able to access ShUShER in your browser at `localhost:4000`
114+
### Compiling UShER to WebAssembly

0 commit comments

Comments
 (0)