https://github.com/ssciwr/predictcr
In development
https://github.com/ssciwr/predictcr
Last synced: 8 months ago
JSON representation
In development
- Host: GitHub
- URL: https://github.com/ssciwr/predictcr
- Owner: ssciwr
- License: mit
- Created: 2024-08-23T12:04:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-22T13:37:06.000Z (12 months ago)
- Last Synced: 2024-10-23T08:38:36.479Z (12 months ago)
- Language: Python
- Homepage: https://predictcr.lkeegan.dev
- Size: 1.74 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
predicTCR website
[](https://github.com/ssciwr/predicTCR/actions/workflows/ci.yml)
The source code for the [predicTCR website](https://predictcr.com/).
## Implemented features
### Users
Users of the site can
- sign up with a valid email address
- upload a sample to be analyzed
- see a list of their requested samples
- download the analysis results
### Admins
Users with admin rights can additionally
- view and modify global settings
- create an API token for a runner to use
- view and modify registered users and runners
- view and download samples and results
## Runners
The analysis of the samples is done by runners, which
- are a separate service packaged as a docker container
- can be run on any machine with docker installed
- authenticate with the API using a token
- regularly check for new samples to analyze
- do sample analysis and upload the results
## Developer info
If you want to make changes to the code, see
[README_DEV](README_DEV.md)
for instructions on how to locally build make a test deployment of the website.
## Deployment info
For information on how to deploy the website see
[README_DEPLOYMENT](README_DEPLOYMENT.md).
## Acknowledgments
This project is based on the [SampleFlow](https://github.com/ssciwr/sample_flow) web service by the same authors.