\documentclass[letterpaper]{scrartcl} % or whatever
  \usepackage{tgpagella}
  \setkomafont{disposition}{
  ormalfont\bfseries}
  %\usepackage[markuppercase]{scrpage2}
  \title{\huge Design Use Cases}
  \date{\today}
  \author{\Large Students With A Goal (S.W.A.G.)}
  \usepackage[pass]{geometry}
  \usepackage{hyperref}

  \usepackage{graphicx}

  \usepackage{enumitem}
  \setlist[description]{style=multiline,leftmargin=3cm,font=
  ormalfont\textbf}
  \setlistdepth{9}
  
  \setlist[itemize,1]{label=$\bullet$}
  \setlist[itemize,2]{label=$\bullet$}
  \setlist[itemize,3]{label=$\bullet$}
  \setlist[itemize,4]{label=$\bullet$}
  \setlist[itemize,5]{label=$\bullet$}
  \setlist[itemize,6]{label=$\bullet$}
  \setlist[itemize,7]{label=$\bullet$}
  \setlist[itemize,8]{label=$\bullet$}
  \setlist[itemize,9]{label=$\bullet$}
  \renewlist{itemize}{itemize}{9}
  \begin{document}
  \maketitle
  \begin{center}

  \includegraphics[width=12cm]{../swag_logo.png}\\

  \begin{tabular}{l r}
  Melody Jeng & System Architect \\
  Arno Gau & Senior System Analyst \\
  Rachel Lee & Software Development Lead \\
  Laura Hawkins & Project Manager \\
  Rohan Rangray & Algorithms Specialist\\
  Andrew Buss & Database Specialist \\
  Phuong Tran & Quality Assurance Lead \\
  Chung Kang Wang & Business Analyst\\
  Masud Rahman & User Interface Specialist\\
  Kevin Mach & User Interface Specialist\\
  \end{tabular}
  \end{center}

  
  ewpage

  \tableofcontents
  
  ewpage

  \section{Accounts}
  \subsection{[A1] User Registration}
  \begin{description}[style=multiline,leftmargin=3cm]
  \item[Description]{To create and save decks, the system requires the user
  to create an account prior. The user will be able to create an account
  through registering.}
  \item[Desired Outcome]{An account will be created for the user from the
  specified username, password, email. The user will be able to log into
  the aforementioned account.}

  \\

  \item[User Goals]{The user shall have an account to participate in the

  application's activities.}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{None}
  \\
  \item[Priority Level]{``Must''}

  \item[Status]{Implemented}

  \item[Pre-conditions]: None.

  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The user has an account registered with the system.}
  \end{itemize}
  
  \item[Trigger]{The user wants to create an account.}
  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The frontend renders the login form described in login.html.}
  \item
    {The User shall click the sign up toggle.}

  \item

    {The frontend shall render a registration form and display it to the User.}

  \item

    {The User shal fill in the form.}

  \item

    {The frontend checks that the provided email is not invalid, and that

    the password is not valid. If anything is not valid, it displays an
    error and returns this to the user. }
  \item

    {If the form is valid, the frontent POSTs the form in JSON format to the
    server API at /api/verify\_email/.}

  \item

    {The backend deserializes and validates the data in /api/register. If it's not valid, it
    returns an error to the frontend.}

  \item

    {The backend creates a new User object from the provided data, filling
    in the email and password fields in models.py in model method create\_user.}

  \item

    {The backend saves the User object in models.py.}

  \item

    {The backend marks the User's email as unverified.}

  \item

    {The backend sends an email to the User's address with a link to
    validate the user's email address from models.py in function send\_confirmation\_email.}

  \item

    {The backend responds with success and logs the User in on a new
    session for the User. }

  \item

    {The frontend reports success to the User and stores the sessionid for

    future requests.}
  \end{enumerate}

  {Verification Workflow:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User receives an email with a link to verify their email. The
    User clicks the link}

  \item

    {The frontend in VerifyEmailController submits a POST request to the backend.}

  \item

    {The backend validates the code in views.py in function veryify\_email. If the code is not valid, it returns
    an error to the frontend.}

  \item

    {The backend marks the user's email as confirmed and saves the User object
    again in models.py in function confirm\_email. The user's account is now active.}

  \item

    {The frontend's VerifyEmailController.js reports success and logs the User in to the application. }

  \end{enumerate}
  
  \end{description}
  
  
  ewpage

  \subsection{[A2] User Login}

  
  \begin{description}
  \item[Description]{User is able to login to personal account.}

  \item[Desired Outcome]{The user shall be able to provide their username and

  password to access their courses and flash cards. The user shall gain
  access to the list of the courses they have added, and be able to review
  the flash cards they have added to their decks.}

  \\

  \item[User Goals]{The user wants to resume use of the site on another
  device, or use the site after logging out.}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration}
  \\
  \item[Priority Level]{``Must''}

  \item[Status]{Implemented}

  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has registered an account.}
    {The User knows their email and password.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User can navigate the site and see their data.}

  \end{itemize}

  \item[Trigger]{The User wants to use the application and its core features.}

  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

  {The frontend shall render the login form described in login.html and implemented in LoginController.js}
  \item
  {The User shall type in their email and password.}

  \item

    {The backend shall verify that the User has submitted their email and password in views.py in function login.}

  \item

    {The backend shall check that the User is active in views.py in function login.}

  \item

    {The backend shall log the User in using the Django login feature.}
  \item
    {The frontend shall displays the home page for the User.}

  \end{enumerate}

  \end{description}

  
  ewpage

  \subsection{[A3] Add a Class}

  \begin{description}

  \item[Description]{The User shall be able to add a class and access the

  flashcards associated with that class.}

  \item[Desired Outcome]{The class shall be connected to the student's account
  and the User shall have the ability to read and publish flashcards

  for this class.}

  \\

  \item[User Goals]{The User wants to publish flashcards for this class, and
  read the flashcards for this class that are published by other users.}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login}

  \\
  \item[Priority Level]{``Must''}

  \item[Status]{Implemented}

  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has registered an account.}

  \item

    {The User has successfully logged in to the application.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User can view the flashcards being published for the class and
    add them to their deck.}

  \item

    {The User can publish flashcards to be viewed and added by other users

    in the same class.}
  \end{itemize}

  \item[Trigger]{The User wants to make flashcards and view flashcards for a class.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User shall click "Add a Class" from the drop down menu in the upper left hand corner.}

  \item

    {The frontend shall navigate to the new page described by addclass.html.}

  \item

    {The User shall begin to type the class department code, course title, course number, or instructor in the text box.}

  \item

    {The frontend in ClassAddController.js shall send a get request to the backend at api/sections/search/.}

  \item

    {The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.}
  \item
    {The frontend shall show the classes that the backend has found.}
  \item
    {The User shall select from the classes the one that they want to add.}
  \item
    {The frontend shall enable the 'Add Class' button.}
  \item
    {The User shall click 'Add Class' button to the right of the text box.}
  \item
    {The frontend shall send a post request to api/sections/.}
  \item
    {The backend shall in views.py in function enroll shall call the method enroll in models.py.}
  \item
    {The backend in models.py in function enroll shall add the class to the User's sections.}
  \item
    {The frontend shall redirect the User to the class's Live Feed using the ClassAddController.js.}
  \item
    {The frontend shall present the live feed for the class by using feed.html and FeedController.js.}

  \end{enumerate}
  
  \item[Alternate Workflow: User is whitelisted.\\]

  \begin{enumerate}
  \setcounter{enumi}{3}
  \itemsep1pt\parskip0pt\parsep0pt

  \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
  \item
    {The User shall select their desired class, which has a whitelist, by clicking on ``Add Class''.}

  \item

    {The frontend shall submit a POST request to /api/me/sections with
    the course ID that the User typed. }

  \item

    {The backend shall check if there is a whitelist for the class that the 
    User has selected in models.py at function is\_whitelisted.}

  \item

    {The backend shall check if the user is on the whitelist in models.py 
    in function is\_user\_on\_whitelist.}

  \item

    {The backend shall add the User to the class following steps above.}

  \item

    {The frontend shall redirect the User to the class's live feed followed the last step in the Workflow above.}

  \end{enumerate}

  
  \item[Alternate Workflow: User is not whitelisted.]
  \begin{enumerate}

  \setcounter{enumi}{7}

  \itemsep1pt\parskip0pt\parsep0pt

  \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}

  \item

    {The backend shall will check that the user is in the whitelist in models.py.}

  \item

    {The frontend shall display that the class is whitelisted and the Add Class button will not be enabled.}

  \end{enumerate}

  \end{description}
  {}
  
  
  ewpage
  
  {}

  \subsection{[A4] Drop a Class}

  
  \begin{description}

  \item[Description]{The User can remove themselves from a course he/she is

  registered to}

  \item[Desired Outcome]{The User has dropped the class and no longer need

  access to the flashcards for said class. This means they can no longer
  see the flashcards associated to the class that they dropped }

  \\

  \item[User Goals]{The User shall not have access to a class and the

  flashcards associated with that class. They will no longer see the class

  listed in their drop down menu.}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class}

  \\
  \item[Priority Level]{ ``Should''}

  \item[Status]{Implemented }

  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has a valid account.}

  \item

    {The User is logged in.}

  \item

    {The User has enrolled in at least one class.}
  \item
    {The User has navigated to the Settings page.}

  \end{itemize}

  \item[Post-conditions]{}

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall no longer have access to dropped class, or associated
    flashcards}
  \end{itemize}

  \item[Trigger]{User no longer wants to see flashcards from that class.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User shall click `Drop' button to the right of the class they wish to drop.}

  \item

    {The frontend shall submit a DELETE request to

    /api/me/sections/\textless{}section ID number\textgreater{}.}

  \item

    {The backend shall check that the User is enrolled in the section in models.py in function drop.}

  \item

    {The server shall remove the selected class from a user's list of section in models.py in function drop. }

  \item

    {The frontend shall remove the class from the list in setting and show toast reading 'Dropped'.}

  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}

  \subsection{[A5] Password change}

  
  \begin{description}

  \item[Description]{The User shall be able to change the password for their
  account in the account settings. }

  \item[Desired Outcome]{The User's password shall be changed and the User

  shall be able to log in with the new password in the future}

  \\\\

  \item[User Goals]{The User wants to use a different password in the future}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login}

  \\

  \item[Details]{The User provides their current password and a new password

  in a form. If the current password is correct, the system updates their
  password to the requested new password.}

  \item[Priority Level]{``Must''}

  \item[Status]{Implemented}

  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has registered an account.}

  \item

    {The User has logged in.}

  \item

    {The User knows their current password.}
  \item
    {The User has navigated to the Settings page.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User's password is changed}

  \item

    {The User can log in with the new password}

  \end{itemize}

  \item[Trigger]{The User wants to change their password.}

  \item[Error Handling] 
  \begin{description}
  \item[\small Missing Fields] \begin{itemize}
  \item The client shall enforce required fields
  \item The server will return an HTTP Bad Request error to the client.
  \end{itemize}
  \item[\small Incorrect Old Password] \begin{itemize}
  \item The server will return an HTTP Forbidden error to the client.
  \end{itemize}
  \item[\small Blank New Password] \begin{itemize}
  \item The server will return an HTTP Bad Request error to the client.
  \end{itemize}
  \end{description}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The frontend shall render a form that requires the user to enter their
    old password and new password from settings.html}

  \item

    {The User shall type in their current password, the desired new
    password, and retype the desired new password to confirm.}

  \item

    {The frontend shall submit the data to the server by sending a PATCH

    request to /api/me containing ``old\_password'' and

    ``new\_password'' values in SettingsController.js.}

    \item (The )

  \item

    {The backend shall check the user's current password in views.py in function patch under UserDetail.}
  \item  The backend shall update the user's current password in views.py in function patch under UserDetail.

  \item

    {The frontend shall present a toast reading "Password successfully changed" and redirect the User to the Add a Class page.}

  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}

  \subsection{[A6] Password reset}

  
  \begin{description}

  \item[Description]{The User shall be able to reset their password without
  being logged in.}

  \item[Desired Outcome]{The User's password shall be changed to one that
  they remember.}

  \\

  \item[User Goals]{The User will be able to log into the site with a new password.}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration}
  \\
  \item[Details]{The user provides their email in a password reset form. If

  the address is valid, the site sends a password reset link with a random
  token to that address. If the address is invalid, the site does not send
  a link. For security reasons, we do not reveal to the user whether the
  email address was valid, and we expire the link after 24 hours. When a
  user visits the link emailed to them, they are able to specify a new
  password in a form. When they submit the form, their password is updated
  if the token is correct. }

  \item[Priority Level]{``Must''}

  \item[Status]{Implemented}

  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has created an account before.}

  \item

    {The User knows the email address attached to their account for our application.}
  \item 
    {The User can log into their email account.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User's password is changed.}

  \item

    {The User can log in with the new password.}

  \end{itemize}

  \item[Trigger]{The User wants to log into the site but does not know their password.}
  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

  {The User clicks ``Forgot Password'' text on the login page}

  \item

    {The frontend shall render the password reset page from the template requestpasswordreset.html.}

  \item

    {The User shall type in their email address for their account and click the "Reset" button.}

  \item

    {The frontend shall send a POST request to /api/request\_password\_reset/ from RequestResetController.js.}

  \item

    {The backend shall check if an account exists with the email entered by
    the User in views.py in function request\_password\_reset.}

  \item

    {The backend shal send an email to the User with a link to the password reset page in models.py in function
    request\_password\_reset.}

  \item

    {The User will navigate to their email account, open the email, and click the link.}

  \item

    {The frontend shall render the password reset page from the template resetpassword.html.}
  \item 
    {The User shall type in their new password and re-type it to confirm it.}
  \item 
    {The frontend shall check if the new password is long enough and if the confirmed password is the same as
    the new password in ResetPasswordController.js.}

  \item

    {The frontend shall send a POST request to /api/reset\_password from ResetPasswordController.js.}

  \item

    {The backend shall change the user's password in views.py in function reset\_password.}

  \item

    {The frontend shall redirect the User to the login page. }

  \item

    {The User shall use their new password to login to the application.}

  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}

  \subsection{[A7] Limit Student Access to Courses}

  
  \begin{description}
  \item[Description]{The instructor shall be able to limit access to the
  courses that he is in charge of by whitelisting only those students that
  are actually in the class.}

  \item[Desired Outcome]{The class will have limited access and only those

  users who are whitelisted may enroll in the class.}

  \\

  \item[User Goals]{The instructor wants to limit access to his class so only
  the students who are actually in his class participate, and nobody
  else.}

  \item[Primary Actor]{Instructor}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login}

  \\
  \item[Priority Level]{``Should''}

  \item[Status]{Implemented}

  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has valid instructor's account}
  \end{itemize}

  \item[Post-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {Only those users who were whitelisted may add the class.}
  \end{itemize}

  \item[Trigger]{The course instructor wants to limit the students who
  can add his class on our application.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The instructor emails the administrators from his UCSD email address
    and requests to limit access to his course. He provides a list of
    emails of the students that are to be whitelisted.}
  \item
    {The administrators visit a custom admin page, select the course, and
    paste the list of emails. They submit the page directly (no separate
    frontend here) to the server.}
  \item

    {The backend shall create a WhitelistedAddress for each provided email,

    attaching it to the section taught by the instructor.}
  \item

    {The backend shall add any existing users whose email addresses appear

    in the whitelist to the class. }
  \end{enumerate}
  \end{description}
  
  ewpage

  \subsection{[A8] User Logout}

  
  \begin{description}

  \item[Description]{The User shall be able to log out of his/her account on

  the site.}

  \item[Desired Outcome]{The User's information and data will no longer be

  accessible after logging out. }

  \\

  \item[User Goals]{The User is done with his/her session of using the

  website, and wants to make sure others cannot access the data in his/her
  account.}

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases] None
  \\
  \item[Priority Level]{``Must''}

  
  \item[Status]{Implemented}

  \item[Pre-conditions]{The user is logged into their account}

  \item[Post-conditions]{}{The user's data can no longer be accessed.}

  \item[Trigger]{The User no longer wants to be logged into the application.}

  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User clicks the 'Logout' button in the upper right hand corner.}

  \item

    {The backend shall log the User out using the Django logout feature.}
  \item
    {The frontend renders the application login page using login.html.}

  \end{enumerate}

  \end{description}

  
  
  ewpage

  \subsection{[A9] Contact Admin}

  
  \begin{description}

  \item[Description]{The User shall be able to contact the admin.}

  \item[Desired Outcome]{The User shall send a message to the admin; the

  admin shall receive the message.}

  {User Goals:}{The User sends a message to the admin.}

  \item[Primary Actor]{User}

  \item[Dependency Use Cases]{None}
  \\
  \item[Priority Level]{``Must''}

  \item[Status]{Implemented}

  \item[Pre-conditions]{The User has an account registered and is logged in.}

  \item[Post-conditions]{The admin receives the user's message.}

  \item[Trigger]{The User wants to contact the adiminstators of the site with
  bug reports, questions, or praise. }

  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

     {The User shall click the '?' button in the right half of the navbar.}

  \item
     {The frontend shall render the page using the help.html template.}
  \item 
     {The User shall scroll to the bottom of the page.}
  \item 
     {The User shall click the text reading "Send Us an Email!"}
  \item
     {The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.}
  \item
     {The User shall see our email address in the recipients text box.}

  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}

  \section{Flashcards}

  \subsection{[F1] Push Flashcard}

  
  \begin{description}

  \item[Description]{The User shall be able to create a flashcard with their

  input. }

  \item[Desired Outcome]{The User shall have the flashcard added to their own

  deck and the Live Feed. }

  \\

  \item[User Goals]{The User will see their flashcard in their deck and the

  flashcard will be shared with others. }

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class}

  \\
  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has an account.}

  \item

    {The User has added at least one class.}

  \item

    {The User has navigated to the live feed for a class.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has flashcard added to their deck.}

  \item

    {The Flashcard is shown in the Live Feed.}

  \item

    {Other users can add this flashcard to their decks.}

  \end{itemize}

  \item[Trigger]{The User wants to make a flashcard to study.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User is at the live feed for the class from feed.html.}

  \item

    {The User shall click on the '+' button at the bottom right of the screen.}

  \item

    {The frontend shall present a modal for inputting the flashcard text to the User.}

  \item

    {The User shall type in the content of their flashcard.}

  \item

    {The User shall highlight keywords in the flashcard text.}

  \item

    {The User shall click on the `Contribute' button.}

  \item {The frontend shall generate a POST request consisting of the flashcard text,
    blanks, and material date, in JSON form in FeedController.js and send it to /api/flashcards/.}

  \item

    {The backend shall obtain the flashcard information by deserializing
    the JSON in the POST request in views.py.}

  \item

    {The backend shall create a new record for this flashcard in the
    Flashcards table in the database in models.py.}

  \item

    {The frontend shall publish the newly created card to the live feed of
    the class using FeedController.js.}

  \end{enumerate}
  \end{description}

  
  ewpage

  {}

  \subsection{[F2] Edit Flashcard}

  
  \begin{description}

  \item[Description]{The User shall be able to duplicate the flashcard authored by a different user and make changes to it.}

  \item[Desired Outcome]{The new flashcard is edited and saved appropriately.}

  \\

  \item[User Goals]{To create a flashcard similar to an existing flashcard but with minor changes.}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
  Flashcard}
  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The flashcard to be edited is visible in the user's feed view or deck view.}

  \item

    {The user is currently in the feed view or the deck view of the course the card to be edited belongs to.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {A duplicate flashcard with some differences is created.}

  \end{itemize}

  \item[Trigger] {The User wants to duplicate a card and make some changes to it and thus create a new flashcard.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt

  \item{The user shall hover over the card to be edited and and click on the
    pencil button that appears on the bottom left of the card.}

  \item

    {The frontend shall produce an editable dialog box containing the flashcard

    text }

  \item
    {The user shall make desired changes}
  \item

    {The user shall click `Save Changes'}

  \item

    {The client shall generate a PATCH request for a new flashcard in CardGridController.js
    and send it to the server at /api/flashcards/}

  \item
    {If the user changed only the blanks of the cards, the server shall
    create a new FlashcardMask object and update the appropriate
    UserFlashcard object with a reference to it.}
  \item
    {If the user changed the text of the card, the server will instead:}

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {Create a new flashcard for the section}

  \item

    {Push it to the feed}

  \item

    {Add it to the user's deck}

  \item

    {Hide the old card from the user}

  \item

    {Return the new card to the user}
  \end{enumerate}

  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}

  \subsection{[F3] Pull Flashcard}

  \begin{description}
  \item[Description]{The User shall be able to add flash cards to their own

  deck from the Live Feed. }

  \item[Desired Outcome]{The User shall have the flashcard added to their own

  deck }

  \\

  \item[User Goals]{The user will be able to review that flashcard. }

  \item[Primary Actor]{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard}
  \\
  \item[Priority Level]{``Must'' }

  \item[Status]{Implemented}

  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {A flashcard has been created and is in the Live Feed for a class. }

  \item

    {The User is currently viewing the Live Feed for that class.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {User shall have that flashcard added to their deck.}

  \item

    {User can review this flashcard later.}

  \end{itemize}

  \item[Trigger]{The User wants to save a flashcard for review later.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The user shall hover over the flashcard he wants to add to his deck and click on the '+'
    icon that appears in the center of the card.}

  \item

    {The frontend shall make the pulled Flashcard appear in the user's deck.}

  \item

    {The frontend shall generate a POST request in FlashcardFactory.js and send it to

    /api/flashcards/\textless{}flashcard id\textgreater{}/pull}
  \item

    {The server shall call the FlashcardViewSet.pull to handle the POST request sent by the frontend.}
  \item
    {The FlashcardViewSet.pull method should call the user.pull method in models.py with the flashcard object
    to be pulled as an argument}
  \item
    {The user.pull method shall create a UserFlashcard object associated with the request's user and the
    passed in flashcard object and save it in the database.}

  \item
    {The server shall notify connected clients about the new card rating,
    if any}
  \item
    {Connected clients will take the new rating into account when next
    rearranging the feed.}
  \end{enumerate}
  \end{description}
  
  ewpage
  
  {}

  \subsection{[F4] Flag Inappropriate Cards}

  
  \begin{description}
  \item[Description]{Cards may be flagged indicating inappropriate content}

  \item[Desired Outcome]{The flashcard's inappropriateness variable is

  adjusted.}

  \\

  \item[User Goals]{To notify the admins if a card is inappropriate and

  should not be displayed in the feed.}

  \item[Primary Actor]{User (Student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}

  \\
  \item[Priority Level]{``Should''}

  \item[Status]{Implemented}

  
  \item[Pre-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The user is enrolled in a class}

  \item

    {The flashcard has been created.}

  \item

    {The flashcard is viewable in feed.}

  \item

    {The user has clicked the red 'eye' icon on the flashcard which is the "Hide Card" button.}

  \end{itemize}
  
  \item[Post-conditions]
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {Flashcard is hidden from user.}

  \item

    {The flashcard is marked as being inappropriate.}

  \end{itemize}

  \item[Trigger]{The User does not like the particular flashcard.}

  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The frontend displays a toast that offers the user the report text.}
  \item
    {The user clicks the ``Report'' text on the flashcard.}
  \item
    {The frontend shall hide the flashcard from the user in FlashcardFactory.js.}

  \item

    {The frontend shall generate a POST request in Flashcard.report in FlashcardFactory.js
    and send it to /api/flashcards/\textless{}flashcard id \textgreater{}/report}

  \item

    {The backend shall check if the user already hid the flashcard in views.py function report.}

  \item

    {The backend shall hide the flashcard in models.py in class FlashcardHide. }

  \end{enumerate}
  \end{description}
  {}
  
  {}
  
  
  ewpage
  
  {}

  \subsection{[F5] Filter Flashcards}

  
  \begin{description}

  \item[Description]{The user is able to filter for flashcards by material date and text.}

  \item[Desired Outcome]{The user shall see flashcards based on the filter
  options: the material date and the text of the card.}

  {User Goals:}{The user can find what he/she is specifically looking

  for.}

  \item[Primary Actor]{User}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
  Flashcard}

  \\
  \item[Priority Level]{''Should''}

  \item[Status]{Implemented }

  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The user has added a class.}

  \item

    {The class in question contains non-zero number of flashcards.}

  \end{itemize}

  \item[Post-conditions]{}

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The user only sees the flashcards that match his filter criterion.}

  \end{itemize}

  \item[Trigger]{The user wants to only see cards for a specific date range or with a specific substring in their text.}

  
  \item[Workflow]
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The frontend shall render the page described in study.html using CardListController.js.}
  \item
    {The user shall select the weeks that the filtered cards should belong to.}

  \item

    {The user shall type in the appropriate search filter in the text input box on the top right of the screen.}

  \item

    {The frontend generates a POST request with the flashcard dates and the flashcard text filter as
     parameteres and sends it to /api/study.}

  \item

    {The system follows the Study workflow, displaying only cards made within a certain date time.}
    

  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}

  \subsection{[F6] Blank Out Words in Flashcard}

  
  \begin{description}
  \item[Description]{The User shall be able to blank out keywords in any
  flashcard in his deck. }

  \item[Desired Outcome]{The blanked out words in the flashcard notify the

  System that they are keywords. }

  \\

  \item[User Goals]{The User shall mark some words as keywords so the System
  may later quiz theirself by blanking out the keywords and having the
  User guess what they are.}
  
  {Primary Actor: }{User (student)}

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}

  \\
  \item[Priority Level]{``Must''}

  \item[Status]{Implemented.}

  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User has an account and is logged in.}

  \item

    {The User shall be on the Live Feed for the class.}
  \item
    {The User has clicked the 'c' hotkey or the 'plus' button to start making a card.}
  \item
    {The User shall type in information relevant to their class.}

  \end{itemize}
  
  {Post-conditions: }
  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The blanked out words in the flashcard are marked as keywords.}
  \item
    {The System shall blank out the keywords and let the User guess what
    they are when it presents the flashcard to the User for reviewing.}
  \end{itemize}

  \item[Trigger]{The User wants to make a flashcard and be quizzed on parts of the flashcard while they study.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User shall highlight the words that he wishes to blank out.}

  \item

    {The User shall click the 'Contribute' button.}

  \item

    {The backend shall mark those words by updating the field mask for
    that userflashcard object in views.py in function create. }

  \item

    {The backend shall save those in models.py.}

  \item

    {The frontend shall change the color of the text that was blanked out in flashcard.html.}

  \end{enumerate}
  
  {Alternative Workflows:}
  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

   {Precondition: The User has clicked the edit flashcard button instead of creating a new card.}

  \item

    {The User shall highlight selection text and click either ctrl-b or 'Blank Selected Text'.}

  \item

    {The backend shall mark those words by updating the field mask for
    that userflashcard object in views.py in function create. }

  \item

    {The backend shall save those in models.py.}

  \item

    {The frontend shall change the color of the text that was blanked out in flashcard.html.}

  \end{enumerate}
  \end{description}
  {}
  
  
  ewpage
  
  {}

  \subsection{[F7] Fix Flashcard}

  
  \begin{description}
  \item[Description]{The User shall be able to alter a flashcard he/she made
  originally and not have to make a new copy of it.}

  \item[Desired Outcome]{The User shall alter one flashcard and that

  alteration will be shown to all users of that flashcard}

  \\

  \item[User Goals]{The user shall make the flashcard say something different
  than it did originally.}

  \item[Primary Actor]{User (student) }

  \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}

  \\

  \item[Priority Level]{Must}
  
  \item[Status]{Not Implemented}

  \item[Pre-conditions]

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User has created the flashcard}
  \end{itemize}

  \item[Post-conditions]{}

  
  \begin{itemize}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {The user shall see their alteration for that flashcard}
  \item
    {Other users will be notified of the alteration}
  \end{itemize}

  \item[Trigger]{User (creator of original card) has clicked on the button

  ``Edit''}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item
    {User shall select one of the Flashcards they authored.}
  \item
    {User shall select ``Edit'' button on the flashcard.}
  \item
    {Client shall display an ``Edit Flashcard'' view.}
  \item
    {The Flashcard will display editable fields/areas.}
  \item
    {The User shall input any changes to the Flashcard.}
  \item
    {The User shall select the ``Done Editing'' button.}
  \item
    {The Client shall close the ``Edit Flashcard'' view.}
  \item
    {The server shall update the Flashcard's content.}
  \item
    {Client shall notify users with the Flashcard that the Flashcard has
    been edited, allowing the other users to keep or to discard the
    changes.}
  \end{enumerate}
  \end{description}
  {}
  
  {}
  
  {}
  
  
  ewpage
  
  {}

  \subsection{[F8] Hide Cards}

  
  \begin{description}
  \item[Description]{The user shall be able to hide cards from feed}

  \item[Desired Outcome]{The card is no longer visible to the user}
  \\

  \item[User Goals]{The card has been looked at and should be hidden to
  reduce screen clutter}
  
  {Primary Actor: }{User (Student)}

  \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User

  Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}

  \\
  \item[Priority Level]{``Should''}

  {Status:}{Implemented}

  \item[Pre-conditions]{Flashcard is created, flashcard is viewable by user.}

  \item[Post-conditions]{Flashcard is not viewable by user}

  \item[Trigger]{The User no longer wants to see a card in their feed and deck.}

  \item[Workflow]

  
  \begin{enumerate}
  \itemsep1pt\parskip0pt\parsep0pt
  \item

    {The User chooses a class from the drop down menu.}

  \item

    {The frontend renders the Live Feed for the selected class from feed.html.}

  \item

    {The User sees a card they want to hide.}

  \item

    {The User shall press the ``Hide Flashcard'' button on the card to be

    hidden.}
  \item

    {The frontend shall make a request to the backend from FeedController.js.}
  \item
    {The backend shall check if the User has already hidden that card in views.py.}
  \item
    {The backend shall change the falshcard to hidden in the models.py.}
  \item
    {The frontend shall no longer show that card when the feed is rendered.}

  \end{enumerate}
  
  \end{description}
  
  
  ewpage
  
  {}

  \subsection{[F9] View a Feed}

  
  \begin{description}

  \item[Description]{The User shall be able to view Live Feeds for different

  classes}

  \item[Desired Outcome]{The system shall only show the user Live Feeds for

  specific classes. }

  \\

  \item[User Goals]{The User will see only one Live Feed at a time. }