Skip to content

Commit

Permalink
fix: correction README on .env
Browse files Browse the repository at this point in the history
fix: correction README on `.env`
  • Loading branch information
gordonkoehn authored Dec 17, 2024
2 parents 6df66ad + 6ad1a1f commit 9d8e627
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 15 deletions.
1 change: 0 additions & 1 deletion .streamlit/example.secrets.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# .streamlit/secrets.toml
[aws]
AWS_ACCESS_KEY_ID = "xxx"
AWS_SECRET_ACCESS_KEY = "xxx"
Expand Down
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
![AWS S3](https://img.shields.io/badge/AWS%20S3-Cloud-orange)

This project provides a front-end interface for two primary use cases:
- On-demand heatmaps of mutations to identify new variants emerging.
- On-demand variant deconvolution powered by Lollipop.
- On-demand heatmaps of mutations to identify new variants emerging, based on V-Pipe outputs.
- On-demand variant deconvolution powered by LolliPop.
- On-demand heatmaps of resistance mutation – querying LAPIS of clincial data.
- On-demand heatmaps of resistance mutations - querying LAPS of wastewater data.

## Overview

Expand Down Expand Up @@ -53,23 +55,28 @@ The current deployment of this project can be accessed at [biohack24.g15n.net](h
cd vpipe-biohack24-frontend
```

2. Build the Docker image:
```sh
docker build -t vpipe-frontend .
2. Create a `.secrets.toml` file in the `.streamlit` directory with your AWS credentials and S3 bucket information:
```env
AWS_ACCESS_KEY_ID=your_access_key_id
AWS_SECRET_ACCESS_KEY=your_secret_access_key
S3_BUCKET_NAME=your_s3_bucket_name
```

3. Run the Docker container:
```sh
docker run -p 8000:8000 --env-file .env vpipe-frontend
3. Configure the server IP addresses to LAPIS API for clinical and wastewater data in `config.yaml` including ports:
```env
server:
ip_address: "http://3.71.80.16:8000"
lapis_address: "http://3.126.120.246:8080"
```

### Configuration
4. Build the Docker image:
```sh
docker build -t vpipe-frontend .
```

1. Create a `.env` file in the root directory with your AWS credentials and S3 bucket information:
```env
AWS_ACCESS_KEY_ID=your_access_key_id
AWS_SECRET_ACCESS_KEY=your_secret_access_key
S3_BUCKET_NAME=your_s3_bucket_name
5. Run the Docker container:
```sh
docker run -p 8000:8000 vpipe-frontend
```

### Usage
Expand Down

0 comments on commit 9d8e627

Please sign in to comment.