Add README

README.md

@@ -0,0 +1,26 @@
+# SIMBA🦁 QC
+This repository contains the source code of the python shiny app which is recommended to be used for the quality control of the SIMBA🦁 pipeline. The app is available at [https://exbio.wzw.tum.de/simba-qc/](https://exbio.wzw.tum.de/simba-qc/).
+
+## Offline Usage
+### Docker
+The app can be run using the docker image `exbio/simba-qc`. The image can be pulled from the docker hub using the following command:
+```bash
+docker run -p <port>:8080 bigdatainbiomedicine/simba-qc
+```
+The app will be available at [http://localhost:<port>](http://localhost:<port>).
+
+### Local
+The app can also be run locally. The following steps are required to run the app locally:
+1. Clone the repository:
+```bash
+git clone https://github.com/Mye-InfoBank/SIMBA-QC.git
+```
+2. Install the required packages:
+```bash
+pip install -r requirements.txt
+```
+3. Run the app:
+```bash
+cd src
+uvicorn app:app --host 0.0.0.0 --port <port>
+```