Skip to content
Back to milestones

First Beta Release (v1.0.0b)

New issue
Open
Overdue by 4 year(s)
•
Due by September 15, 2022
•Last updated Sep 13, 2022

v1.0.0b of the app should contain all the following features:

Onboarding flow

  1. User creates an account using GitHub OAuth app
  2. User is redirected to BRN onboarding page where they will provide additional details and agree to BRN policies
  3. User submits this form, this triggers verification code sent to their email address
  4. They enter the verification code correctly
  5. Only then are they able to access their profile page

Web UI

In the WebUI, users should be able to do all the following:

  • Update their user info / profile
  • Update email address
  • View their badges
  • View the assessments
  • Launch assessments
  • See assessment statistics

Assessments

  • Minimally, we need tutorial assessments in R and Python full ready, along with R/Python Programming I and II
  • Assessments contain verbose / user-friendly descriptions
  • Assessment pages in the webui should show metadata about #/% of users who successfully completed it

Badges / Assertions

  • Verbose badge descriptions with links to task descriptions on the BRN skill app
  • Automatic metadata injection into badge assertion
    • Metadata should provide a link to the user's archived repo
    • Might also be other metadata worth including here

Deploy

  • Full running version of app at https://skill.bioinformed.app -- no bugs identified by dev testing
  • Full production deployment on AWS via GHA working for all services
  • Production database up and running

Reviewer workflow

  1. Only assessment which require review should give the option to user to request it
  2. Once requested, should trigger Slack Bot to notify reviewers
  3. Slack bot presents users with a button to accept or decline the review
  4. Once accepted, the reviewer is assigned to the repo
  5. Once reviewer "approves", the badge is issued

Assessment completion workflow

  1. User clicks "start assessment" in webui
  2. Assessment tracker entry is created in db
  3. GHBot uploads all files needed for the assessment repo and adds the user
  4. User is directed to go to the repo
  5. User reads instructions and then completes tasks
  6. User issues bot command to check code
  7. User requests review
  8. Once reviewed, badge is issued

User documentation

There should be a notion page which gives verbose documentation of the following:

  • Tutorial / Quickstart
    • A video tutorial should be provided
    • A written tutorial on how to launch and complete the python/R tutorial should be provided (with nice pictures of the interface)
  • Documentation
    • Explanation of each aspect of the web interface
    • Explanation of each aspect of the github interface for completing assessments
9% complete

List view

0 issues of 28 selected