https://github.com/tacc/a2cps-weekly-dash
Weekly dash for A2CPS metrics
https://github.com/tacc/a2cps-weekly-dash
Last synced: over 1 year ago
JSON representation
Weekly dash for A2CPS metrics
- Host: GitHub
- URL: https://github.com/tacc/a2cps-weekly-dash
- Owner: TACC
- Created: 2021-05-18T14:52:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-13T22:53:41.000Z (over 3 years ago)
- Last Synced: 2025-03-29T04:48:51.666Z (over 1 year ago)
- Language: Python
- Size: 570 KB
- Stars: 3
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Weekly Reporting metrics for the A2CPS program
Docker container of Dash App to display A2CPS trial weekly reporting metrics.
This dashboard is intended for use by study personnel and others interested in the reasons why patients either complete or leave the trial.
## Version History
| Version | Date | Description |
| ------ | ------ | ------ |
| 0.0.2 | 11/01/2021 | Update dashboard to use Screening sites for Screening tables. |
| 0.0.1 | 05/18/2021 | Initial dashboard with portions of the data loaded into tables. |
## Dashboard Description
Data from the A2CPS program is loaded via apis that provide information on both all screened patients and those who continue into the program.
This data is cleaned and transformed to create the tables as outlined in the Weekly Report document on Confluence.
# Development Previews
Development previews are built upon commits to the master branch. If you wish to preview the latest
build, you may use the `docker-compose.yml` file. On your local machine with Docker, run:
```
docker-compose up --force-recreate
```
Then browse to `localhost:8050` in your web browser.
# Automatic Container Build information from parent repository.
This repository was forked from the TACC [dash-container](https://github.com/TACC/dash-container) repo.
## Configuring your repository for automatic container builds (text from original repo)
### Github Actions workflows
This repository comes with two Github Action workflows that automatically build Docker containers:
- [build-pr](./github/workflows/build-pr) builds commit sha tagged
images upon pull requests
- [build-main](./github/workflows/build-main) builds a commit sha tagged and `:latest` tagged image upon
pushes to main (such as when merging a pull request)
Both require specific Github repo configuration.
### Setting up a Dockerhub token
You will need to create a token for the account that will be used to push your repo.
- On [Dockerhub](https://hub.docker.com) go to your account's [security settings](https://hub.docker.com/settings/security).
- Click the **New Access Token** button and type in a description
- You will see a UUID value - this is your access token. Copy it immediately, as these can only
be read upon creation. You will not see this token again.
### Setting up a Github Actions environment
You will need to create a build environment with secrets to contain Dockerhub settings.
- In your Github repo, click on **Settings**. Then click on **Environments**
- Click on the **New Environment** button and name this environment `docker`. (You can change the
`environment` value in the workflows if you wish to call it something else or keep multiple environments)
- At the bottom of the screen you will see **Environment Secrets**. Click the **Add Secret** button to create secrets.
- Create a secret called `DOCKERHUB_TOKEN` and paste your Dockerhub token here
- Create a secret called `DOCKERHUB_USERNAME` and put the name of the corresponding user here
- Create a secret called `DOCKERHUB_REPO` and put your Docker repository name here. For example, this Github repo
autobuilds images at `jchuahtacc/dash-container`, so that is the value that is used for `DOCKERHUB_REPO`.
### Test it out
Upon pull requests and pushes to main, you will see the workflows perform autobuilds. You can
view the Action results by going to the **Actions** tag of your repo. You can also go to your [Dockerhub](https://hub.docker.com) page and make sure images are properly getting tagged and pushed