predicTCR website

The source code for the predicTCR website.

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
• TODO automatically receive an email with their 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 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.

Acknowledgments

This project is based on the SampleFlow web service by the same authors.