Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.89 KB

README.md

File metadata and controls

54 lines (38 loc) · 1.89 KB

SampleFlow website

CI codecov sonar

The source code for the SampleFlow website.

Implemented features

Users

Users of the site can

  • sign up with a valid email address
  • request a sample, optionally providing a reference sequence
  • see a list of their requested samples
  • download their reference sequences
  • download full analysis data
  • automatically receive an email with their results

Admins

Users with admin rights can additionally

  • see a list of all users
  • see a list of all requested samples and results
  • change the site settings
    • set which day of the week sample submission closes
    • set number of plate rows/cols
    • add/remove running options
  • download a zipped tsv of requests from the current week
    • this includes the reference sequences as fasta files
  • upload a zipfile with successful analysis results to be sent to the user
  • upload unsuccessful analysis result status to be sent to the user

REST API

Admins can also generate an API token, then do all of the above programatically using the provided REST API:

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.