110swag / docs

\documentclass[letterpaper]{scrartcl} % or whatever

1

\documentclass[letterpaper]{scrartcl} % or whatever

\usepackage{tgpagella}

2

\usepackage{tgpagella}

\setkomafont{disposition}{\normalfont\bfseries}

3

\setkomafont{disposition}{\normalfont\bfseries}

%\usepackage[markuppercase]{scrpage2}

4

%\usepackage[markuppercase]{scrpage2}

\title{\huge Design Use Cases}

5

\title{\huge Design Use Cases}

\date{\today}

6

\date{\today}

\author{\Large Students With A Goal (S.W.A.G.)}

7

\author{\Large Students With A Goal (S.W.A.G.)}

\usepackage[pass]{geometry}

8

\usepackage[pass]{geometry}

\usepackage{hyperref}

9

\usepackage{hyperref}

\usepackage{graphicx}

10

\usepackage{graphicx}

\usepackage{enumitem}

11

\usepackage{enumitem}

\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}

12

\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}

\setlistdepth{9}

13

\setlistdepth{9}

14

\setlist[itemize,1]{label=$\bullet$}

15

\setlist[itemize,1]{label=$\bullet$}

\setlist[itemize,2]{label=$\bullet$}

16

\setlist[itemize,2]{label=$\bullet$}

\setlist[itemize,3]{label=$\bullet$}

17

\setlist[itemize,3]{label=$\bullet$}

\setlist[itemize,4]{label=$\bullet$}

18

\setlist[itemize,4]{label=$\bullet$}

\setlist[itemize,5]{label=$\bullet$}

19

\setlist[itemize,5]{label=$\bullet$}

\setlist[itemize,6]{label=$\bullet$}

20

\setlist[itemize,6]{label=$\bullet$}

\setlist[itemize,7]{label=$\bullet$}

21

\setlist[itemize,7]{label=$\bullet$}

\setlist[itemize,8]{label=$\bullet$}

22

\setlist[itemize,8]{label=$\bullet$}

\setlist[itemize,9]{label=$\bullet$}

23

\setlist[itemize,9]{label=$\bullet$}

\renewlist{itemize}{itemize}{9}

24

\renewlist{itemize}{itemize}{9}

\begin{document}

25

\begin{document}

\maketitle

26

\maketitle

\begin{center}

27

\begin{center}

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

28

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

29

\begin{tabular}{l r}

30

\begin{tabular}{l r}

Melody Jeng & System Architect \\

31

Melody Jeng & System Architect \\

Arno Gau & Senior System Analyst \\

32

Arno Gau & Senior System Analyst \\

Rachel Lee & Software Development Lead \\

33

Rachel Lee & Software Development Lead \\

Laura Hawkins & Project Manager \\

34

Laura Hawkins & Project Manager \\

Rohan Rangray & Algorithms Specialist\\

35

Rohan Rangray & Algorithms Specialist\\

Andrew Buss & Database Specialist \\

36

Andrew Buss & Database Specialist \\

Phuong Tran & Quality Assurance Lead \\

37

Phuong Tran & Quality Assurance Lead \\

Chung Kang Wang & Business Analyst\\

38

Chung Kang Wang & Business Analyst\\

Masud Rahman & User Interface Specialist\\

39

Masud Rahman & User Interface Specialist\\

Kevin Mach & User Interface Specialist\\

40

Kevin Mach & User Interface Specialist\\

\end{tabular}

41

\end{tabular}

\end{center}

42

\end{center}

\newpage

43

\newpage

\tableofcontents

44

\tableofcontents

\newpage

45

\newpage

46

\section{Accounts}

47

\section{Accounts}

\subsection{[A1] User Registration}

48

\subsection{[A1] User Registration}

\begin{description}[style=multiline,leftmargin=3cm]

49

\begin{description}[style=multiline,leftmargin=3cm]

\item[Description]{To create and save decks, the system requires the user

50

\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

51

to create an account prior. The user will be able to create an account

through registering.}

52

through registering.}

\item[Desired Outcome]{An account will be created for the user from the

53

\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

54

specified username, password, email. The user will be able to log into

the aforementioned account.}

55

the aforementioned account.}

\\

56

\\

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

57

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

application's activities.}

58

application's activities.}

59

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

60

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

61

\item[Dependency Use Cases]{None}

62

\item[Dependency Use Cases]{None}

\\

63

\\

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

64

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

65

\item[Status]{Implemented}

66

\item[Status]{Implemented}

67

\item[Pre-conditions]: None.

68

\item[Pre-conditions]: None.

69

\item[Post-conditions]

70

\item[Post-conditions]

71

\begin{itemize}

72

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

73

\itemsep1pt\parskip0pt\parsep0pt

\item

74

\item

{The user has an account registered with the system.}

75

{The user has an account registered with the system.}

\end{itemize}

76

\end{itemize}

77

\item[Trigger]{The user wants to create an account.}

78

\item[Trigger]{The user wants to create an account.}

79

\item[Workflow]

80

\item[Workflow]

81

\begin{enumerate}

82

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

83

\itemsep1pt\parskip0pt\parsep0pt

\item

84

\item

{The frontend renders the login form described in login.html.}

85

{The frontend renders the login form described in login.html.}

\item

86

\item

{The User shall click the sign up toggle.}

87

{The User shall click the sign up toggle.}

\item

88

\item

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

89

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

\item

90

\item

{The User shal fill in the form.}

91

{The User shal fill in the form.}

\item

92

\item

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

93

{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

94

the password is not valid. If anything is not valid, it displays an

error and returns this to the user. }

95

error and returns this to the user. }

\item

96

\item

{If the form is valid, the frontent POSTs the form in JSON format to the

97

{If the form is valid, the frontent POSTs the form in JSON format to the

server API at /api/verify\_email/.}

98

server API at /api/verify\_email/.}

\item

99

\item

{The backend deserializes and validates the data in /api/register. If it's not valid, it

100

{The backend deserializes and validates the data in /api/register. If it's not valid, it

returns an error to the frontend.}

101

returns an error to the frontend.}

\item

102

\item

{The backend creates a new User object from the provided data, filling

103

{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.}

104

in the email and password fields in models.py in model method create\_user.}

\item

105

\item

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

106

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

\item

107

\item

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

108

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

\item

109

\item

{The backend sends an email to the User's address with a link to

110

{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.}

111

validate the user's email address from models.py in function send\_confirmation\_email.}

\item

112

\item

{The backend responds with success and logs the User in on a new

113

{The backend responds with success and logs the User in on a new

session for the User. }

114

session for the User. }

\item

115

\item

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

116

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

future requests.}

117

future requests.}

\end{enumerate}

118

\end{enumerate}

119

{Verification Workflow:}

120

{Verification Workflow:}

121

\begin{enumerate}

122

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

123

\itemsep1pt\parskip0pt\parsep0pt

\item

124

\item

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

125

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

User clicks the link}

126

User clicks the link}

\item

127

\item

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

128

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

\item

129

\item

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

130

{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.}

131

an error to the frontend.}

\item

132

\item

{The backend marks the user's email as confirmed and saves the User object

133

{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.}

134

again in models.py in function confirm\_email. The user's account is now active.}

\item

135

\item

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

136

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

\end{enumerate}

137

\end{enumerate}

138

\end{description}

139

\end{description}

140

\newpage

141

\newpage

\subsection{[A2] User Login}

142

\subsection{[A2] User Login}

143

\begin{description}

144

\begin{description}

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

145

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

146

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

147

\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

148

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

149

access to the list of the courses they have added, and be able to review

the flash cards they have added to their decks.}

150

the flash cards they have added to their decks.}

\\

151

\\

\item[User Goals]{The user wants to resume use of the site on another

152

\item[User Goals]{The user wants to resume use of the site on another

device, or use the site after logging out.}

153

device, or use the site after logging out.}

154

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

155

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

156

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

157

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

\\

158

\\

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

159

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

160

\item[Status]{Implemented}

161

\item[Status]{Implemented}

162

\item[Pre-conditions]

163

\item[Pre-conditions]

164

\begin{itemize}

165

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

166

\itemsep1pt\parskip0pt\parsep0pt

\item

167

\item

{The User has registered an account.}

168

{The User has registered an account.}

{The User knows their email and password.}

169

{The User knows their email and password.}

\end{itemize}

170

\end{itemize}

171

\item[Post-conditions]

172

\item[Post-conditions]

173

\begin{itemize}

174

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

175

\itemsep1pt\parskip0pt\parsep0pt

\item

176

\item

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

177

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

\end{itemize}

178

\end{itemize}

179

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

180

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

181

\item[Workflow]

182

\item[Workflow]

183

\begin{enumerate}

184

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

185

\itemsep1pt\parskip0pt\parsep0pt

\item

186

\item

{The frontend shall render the login form described in login.html and implemented in LoginController.js}

187

{The frontend shall render the login form described in login.html and implemented in LoginController.js}

\item

188

\item

{The User shall type in their email and password.}

189

{The User shall type in their email and password.}

\item

190

\item

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

191

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

\item

192

\item

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

193

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

\item

194

\item

{The backend shall log the User in using the Django login feature.}

195

{The backend shall log the User in using the Django login feature.}

\item

196

\item

{The frontend shall displays the home page for the User.}

197

{The frontend shall displays the home page for the User.}

\end{enumerate}

198

\end{enumerate}

\end{description}

199

\end{description}

\newpage

200

\newpage

201

\subsection{[A3] Add a Class}

202

\subsection{[A3] Add a Class}

\begin{description}

203

\begin{description}

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

204

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

flashcards associated with that class.}

205

flashcards associated with that class.}

206

\item[Desired Outcome]{The class shall be connected to the student's account

207

\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

208

and the User shall have the ability to read and publish flashcards

for this class.}

209

for this class.}

\\

210

\\

\item[User Goals]{The User wants to publish flashcards for this class, and

211

\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.}

212

read the flashcards for this class that are published by other users.}

213

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

214

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

215

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

216

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

Login}

217

Login}

\\

218

\\

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

219

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

220

\item[Status]{Implemented}

221

\item[Status]{Implemented}

222

\item[Pre-conditions]

223

\item[Pre-conditions]

224

\begin{itemize}

225

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

226

\itemsep1pt\parskip0pt\parsep0pt

\item

227

\item

{The User has registered an account.}

228

{The User has registered an account.}

\item

229

\item

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

230

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

\end{itemize}

231

\end{itemize}

232

\item[Post-conditions]

233

\item[Post-conditions]

234

\begin{itemize}

235

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

236

\itemsep1pt\parskip0pt\parsep0pt

\item

237

\item

{The User can view the flashcards being published for the class and

238

{The User can view the flashcards being published for the class and

add them to their deck.}

239

add them to their deck.}

\item

240

\item

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

241

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

in the same class.}

242

in the same class.}

\end{itemize}

243

\end{itemize}

244

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

245

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

246

\item[Workflow]

247

\item[Workflow]

248

\begin{enumerate}

249

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

250

\itemsep1pt\parskip0pt\parsep0pt

\item

251

\item

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

252

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

\item

253

\item

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

254

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

\item

255

\item

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

256

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

\item

257

\item

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

258

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

\item

259

\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.}

260

{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

261

\item

{The frontend shall show the classes that the backend has found.}

262

{The frontend shall show the classes that the backend has found.}

\item

263

\item

{The User shall select from the classes the one that they want to add.}

264

{The User shall select from the classes the one that they want to add.}

\item

265

\item

{The frontend shall enable the 'Add Class' button.}

266

{The frontend shall enable the 'Add Class' button.}

\item

267

\item

{The User shall click 'Add Class' button to the right of the text box.}

268

{The User shall click 'Add Class' button to the right of the text box.}

\item

269

\item

{The frontend shall send a post request to api/sections/.}

270

{The frontend shall send a post request to api/sections/.}

\item

271

\item

{The backend shall in views.py in function enroll shall call the method enroll in models.py.}

272

{The backend shall in views.py in function enroll shall call the method enroll in models.py.}

\item

273

\item

{The backend in models.py in function enroll shall add the class to the User's sections.}

274

{The backend in models.py in function enroll shall add the class to the User's sections.}

\item

275

\item

{The frontend shall redirect the User to the class's Live Feed using the ClassAddController.js.}

276

{The frontend shall redirect the User to the class's Live Feed using the ClassAddController.js.}

\item

277

\item

{The frontend shall present the live feed for the class by using feed.html and FeedController.js.}

278

{The frontend shall present the live feed for the class by using feed.html and FeedController.js.}

279

\end{enumerate}

280

\end{enumerate}

281

\item[Alternate Workflow: User is whitelisted.\\]

282

\item[Alternate Workflow: User is whitelisted.\\]

\begin{enumerate}

283

\begin{enumerate}

\setcounter{enumi}{3}

284

\setcounter{enumi}{3}

\itemsep1pt\parskip0pt\parsep0pt

285

\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.\\}

286

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

\item

287

\item

{The User shall select their desired class, which has a whitelist, by clicking on ``Add Class''.}

288

{The User shall select their desired class, which has a whitelist, by clicking on ``Add Class''.}

\item

289

\item

{The frontend shall submit a POST request to /api/me/sections with

290

{The frontend shall submit a POST request to /api/me/sections with

the course ID that the User typed. }

291

the course ID that the User typed. }

\item

292

\item

{The backend shall check if there is a whitelist for the class that the

293

{The backend shall check if there is a whitelist for the class that the

User has selected in models.py at function is\_whitelisted.}

294

User has selected in models.py at function is\_whitelisted.}

\item

295

\item

{The backend shall check if the user is on the whitelist in models.py

296

{The backend shall check if the user is on the whitelist in models.py

in function is\_user\_on\_whitelist.}

297

in function is\_user\_on\_whitelist.}

\item

298

\item

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

299

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

\item

300

\item

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

301

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

\end{enumerate}

302

\end{enumerate}

303

\item[Alternate Workflow: User is not whitelisted.]

304

\item[Alternate Workflow: User is not whitelisted.]

\begin{enumerate}

305

\begin{enumerate}

\setcounter{enumi}{7}

306

\setcounter{enumi}{7}

\itemsep1pt\parskip0pt\parsep0pt

307

\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.\\}

308

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

\item

309

\item

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

310

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

\item

311

\item

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

312

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

\end{enumerate}

313

\end{enumerate}

314

\end{description}

315

\end{description}

{}

316

{}

317

\newpage

318

\newpage

319

{}

320

{}

321

\subsection{[A4] Drop a Class}

322

\subsection{[A4] Drop a Class}

323

\begin{description}

324

\begin{description}

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

325

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

registered to}

326

registered to}

327

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

328

\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

329

access to the flashcards for said class. This means they can no longer

see the flashcards associated to the class that they dropped }

330

see the flashcards associated to the class that they dropped }

\\

331

\\

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

332

\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

333

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

listed in their drop down menu.}

334

listed in their drop down menu.}

335

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

336

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

337

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

338

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

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

339

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

\\

340

\\

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

341

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

342

\item[Status]{Implemented }

343

\item[Status]{Implemented }

344

\item[Pre-conditions]

345

\item[Pre-conditions]

346

\begin{itemize}

347

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

348

\itemsep1pt\parskip0pt\parsep0pt

\item

349

\item

{The User has a valid account.}

350

{The User has a valid account.}

\item

351

\item

{The User is logged in.}

352

{The User is logged in.}

\item

353

\item

{The User has enrolled in at least one class.}

354

{The User has enrolled in at least one class.}

\item

355

\item

{The User has navigated to the Settings page.}

356

{The User has navigated to the Settings page.}

\end{itemize}

357

\end{itemize}

358

\item[Post-conditions]{}

359

\item[Post-conditions]{}

360

\begin{itemize}

361

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

362

\itemsep1pt\parskip0pt\parsep0pt

\item

363

\item

{User shall no longer have access to dropped class, or associated

364

{User shall no longer have access to dropped class, or associated

flashcards}

365

flashcards}

\end{itemize}

366

\end{itemize}

367

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

368

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

369

\item[Workflow]

370

\item[Workflow]

371

\begin{enumerate}

372

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

373

\itemsep1pt\parskip0pt\parsep0pt

\item

374

\item

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

375

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

\item

376

\item

{The frontend shall submit a DELETE request to

377

{The frontend shall submit a DELETE request to

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

378

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

\item

379

\item

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

380

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

\item

381

\item

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

382

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

\item

383

\item

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

384

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

\end{enumerate}

385

\end{enumerate}

\end{description}

386

\end{description}

\newpage

387

\newpage

388

{}

389

{}

390

\subsection{[A5] Password change}

391

\subsection{[A5] Password change}

392

\begin{description}

393

\begin{description}

\item[Description]{The User shall be able to change the password for their

394

\item[Description]{The User shall be able to change the password for their

account in the account settings. }

395

account in the account settings. }

396

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

397

\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}

398

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

\\\\

399

\\\\

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

400

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

401

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

402

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

403

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

404

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

Login}

405

Login}

\\

406

\\

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

407

\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

408

in a form. If the current password is correct, the system updates their

password to the requested new password.}

409

password to the requested new password.}

410

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

411

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

412

\item[Status]{Implemented}

413

\item[Status]{Implemented}

414

\item[Pre-conditions]

415

\item[Pre-conditions]

416

\begin{itemize}

417

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

418

\itemsep1pt\parskip0pt\parsep0pt

\item

419

\item

{The User has registered an account.}

420

{The User has registered an account.}

\item

421

\item

{The User has logged in.}

422

{The User has logged in.}

\item

423

\item

{The User knows their current password.}

424

{The User knows their current password.}

\item

425

\item

{The User has navigated to the Settings page.}

426

{The User has navigated to the Settings page.}

\end{itemize}

427

\end{itemize}

428

\item[Post-conditions]

429

\item[Post-conditions]

430

\begin{itemize}

431

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

432

\itemsep1pt\parskip0pt\parsep0pt

\item

433

\item

{The User's password is changed}

434

{The User's password is changed}

\item

435

\item

{The User can log in with the new password}

436

{The User can log in with the new password}

\end{itemize}

437

\end{itemize}

438

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

439

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

440

\item[Error Handling]

441

\item[Error Handling]

\begin{description}

442

\begin{description}

\item[\small Missing Fields] \begin{itemize}

443

\item[\small Missing Fields] \begin{itemize}

\item The client shall enforce required fields

444

\item The client shall enforce required fields

\item The server will return an HTTP Bad Request error to the client.

445

\item The server will return an HTTP Bad Request error to the client.

\end{itemize}

446

\end{itemize}

\item[\small Incorrect Old Password] \begin{itemize}

447

\item[\small Incorrect Old Password] \begin{itemize}

\item The server will return an HTTP Forbidden error to the client.

448

\item The server will return an HTTP Forbidden error to the client.

\end{itemize}

449

\end{itemize}

\item[\small Blank New Password] \begin{itemize}

450

\item[\small Blank New Password] \begin{itemize}

\item The server will return an HTTP Bad Request error to the client.

451

\item The server will return an HTTP Bad Request error to the client.

\end{itemize}

452

\end{itemize}

\end{description}

453

\end{description}

\item[Workflow]

454

\item[Workflow]

455

\begin{enumerate}

456

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

457

\itemsep1pt\parskip0pt\parsep0pt

\item

458

\item

{The frontend shall render a form that requires the user to enter their

459

{The frontend shall render a form that requires the user to enter their

old password and new password from settings.html}

460

old password and new password from settings.html}

\item

461

\item

{The User shall type in their current password, the desired new

462

{The User shall type in their current password, the desired new

password, and retype the desired new password to confirm.}

463

password, and retype the desired new password to confirm.}

\item

464

\item

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

465

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

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

466

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

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

467

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

\item (The )

468

\item (The )

\item

469

\item

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

470

{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.

471

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

\item

472

\item

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

473

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

\end{enumerate}

474

\end{enumerate}

\end{description}

475

\end{description}

{}

476

{}

477

\newpage

478

\newpage

479

{}

480

{}

481

\subsection{[A6] Password reset}

482

\subsection{[A6] Password reset}

483

\begin{description}

484

\begin{description}

\item[Description]{The User shall be able to reset their password without

485

\item[Description]{The User shall be able to reset their password without

being logged in.}

486

being logged in.}

487

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

488

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

they remember.}

489

they remember.}

\\

490

\\

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

491

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

492

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

493

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

494

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

495

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

\\

496

\\

\item[Details]{The user provides their email in a password reset form. If

497

\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

498

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

499

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

500

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

501

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

502

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

503

password in a form. When they submit the form, their password is updated

if the token is correct. }

504

if the token is correct. }

505

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

506

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

507

\item[Status]{Implemented}

508

\item[Status]{Implemented}

509

\item[Pre-conditions]

510

\item[Pre-conditions]

511

\begin{itemize}

512

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

513

\itemsep1pt\parskip0pt\parsep0pt

\item

514

\item

{The User has created an account before.}

515

{The User has created an account before.}

\item

516

\item

{The User knows the email address attached to their account for our application.}

517

{The User knows the email address attached to their account for our application.}

\item

518

\item

{The User can log into their email account.}

519

{The User can log into their email account.}

\end{itemize}

520

\end{itemize}

521

\item[Post-conditions]

522

\item[Post-conditions]

523

\begin{itemize}

524

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

525

\itemsep1pt\parskip0pt\parsep0pt

\item

526

\item

{The User's password is changed.}

527

{The User's password is changed.}

\item

528

\item

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

529

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

\end{itemize}

530

\end{itemize}

531

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

532

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

\item[Workflow]

533

\item[Workflow]

534

\begin{enumerate}

535

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

536

\itemsep1pt\parskip0pt\parsep0pt

\item

537

\item

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

538

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

\item

539

\item

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

540

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

\item

541

\item

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

542

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

\item

543

\item

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

544

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

\item

545

\item

{The backend shall check if an account exists with the email entered by

546

{The backend shall check if an account exists with the email entered by

the User in views.py in function request\_password\_reset.}

547

the User in views.py in function request\_password\_reset.}

\item

548

\item

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

549

{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.}

550

request\_password\_reset.}

\item

551

\item

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

552

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

\item

553

\item

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

554

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

\item

555

\item

{The User shall type in their new password and re-type it to confirm it.}

556

{The User shall type in their new password and re-type it to confirm it.}

\item

557

\item

{The frontend shall check if the new password is long enough and if the confirmed password is the same as

558

{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.}

559

the new password in ResetPasswordController.js.}

\item

560

\item

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

561

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

\item

562

\item

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

563

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

\item

564

\item

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

565

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

\item

566

\item

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

567

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

\end{enumerate}

568

\end{enumerate}

\end{description}

569

\end{description}

\newpage

570

\newpage

571

{}

572

{}

573

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

574

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

575

\begin{description}

576

\begin{description}

\item[Description]{The instructor shall be able to limit access to the

577

\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

578

courses that he is in charge of by whitelisting only those students that

are actually in the class.}

579

are actually in the class.}

580

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

581

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

users who are whitelisted may enroll in the class.}

582

users who are whitelisted may enroll in the class.}

\\

583

\\

\item[User Goals]{The instructor wants to limit access to his class so only

584

\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

585

the students who are actually in his class participate, and nobody

else.}

586

else.}

587

{Primary Actor: }{User (instructor)}

588

{Primary Actor: }{User (instructor)}

589

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

590

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

Login}

591

Login}

\\

592

\\

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

593

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

594

\item[Status]{Implemented}

595

\item[Status]{Implemented}

596

\item[Pre-conditions]

597

\item[Pre-conditions]

598

\begin{itemize}

599

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

600

\itemsep1pt\parskip0pt\parsep0pt

\item

601

\item

{User has valid instructor's account}

602

{User has valid instructor's account}

\end{itemize}

603

\end{itemize}

604

\item[Post-conditions]

605

\item[Post-conditions]

606

\begin{itemize}

607

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

608

\itemsep1pt\parskip0pt\parsep0pt

\item

609

\item

{Only those users who were whitelisted may add the class.}

610

{Only those users who were whitelisted may add the class.}

\end{itemize}

611

\end{itemize}

612

\item[Trigger]{The course instructor wants to limit the students who

613

\item[Trigger]{The course instructor wants to limit the students who

can add his class on our application.}

614

can add his class on our application.}

615

\item[Workflow]

616

\item[Workflow]

617

\begin{enumerate}

618

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

619

\itemsep1pt\parskip0pt\parsep0pt

\item

620

\item

{The instructor emails the administrators from his UCSD email address

621

{The instructor emails the administrators from his UCSD email address

and requests to limit access to his course. He provides a list of

622

and requests to limit access to his course. He provides a list of

emails of the students that are to be whitelisted.}

623

emails of the students that are to be whitelisted.}

\item

624

\item

{The administrators visit a custom admin page, select the course, and

625

{The administrators visit a custom admin page, select the course, and

paste the list of emails. They submit the page directly (no separate

626

paste the list of emails. They submit the page directly (no separate

frontend here) to the server.}

627

frontend here) to the server.}

\item

628

\item

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

629

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

attaching it to the section taught by the instructor.}

630

attaching it to the section taught by the instructor.}

\item

631

\item

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

632

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

in the whitelist to the class. }

633

in the whitelist to the class. }

\end{enumerate}

634

\end{enumerate}

\end{description}

635

\end{description}

\newpage

636

\newpage

637

\subsection{[A8] User Logout}

638

\subsection{[A8] User Logout}

639

\begin{description}

640

\begin{description}

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

641

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

the site.}

642

the site.}

643

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

644

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

accessible after logging out. }

645

accessible after logging out. }

\\

646

\\

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

647

\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

648

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

account.}

649

account.}

650

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

651

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

652

\item[Dependency Use Cases] None

653

\item[Dependency Use Cases] None

\\

654

\\

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

655

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

656

\item[Status]{Implemented}

657

\item[Status]{Implemented}

658

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

659

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

660

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

661

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

662

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

663

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

664

\item[Workflow]

665

\item[Workflow]

666

\begin{enumerate}

667

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

668

\itemsep1pt\parskip0pt\parsep0pt

\item

669

\item

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

670

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

\item

671

\item

{The backend shall log the User out using the Django logout feature.}

672

{The backend shall log the User out using the Django logout feature.}

\item

673

\item

{The frontend renders the application login page using login.html.}

674

{The frontend renders the application login page using login.html.}

\end{enumerate}

675

\end{enumerate}

676

\end{description}

677

\end{description}

678

\newpage

679

\newpage

680

681

682

\subsection{[A9] Contact Admin}

683

\subsection{[A9] Contact Admin}

684

\begin{description}

685

\begin{description}

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

686

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

687

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

688

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

admin shall receive the message.}

689

admin shall receive the message.}

690

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

691

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

692

\item[Primary Actor]{User}

693

\item[Primary Actor]{User}

694

\item[Dependency Use Cases]{None}

695

\item[Dependency Use Cases]{None}

\\

696

\\

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

697

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

698

\item[Status]{Implemented}

699

\item[Status]{Implemented}

700

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

701

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

702

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

703

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

704

\item[Trigger]{The User wants to contact the adiminstators of the site with

705

\item[Trigger]{The User wants to contact the adiminstators of the site with

bug reports, questions, or praise. }

706

bug reports, questions, or praise. }

707

\item[Workflow]

708

\item[Workflow]

709

\begin{enumerate}

710

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

711

\itemsep1pt\parskip0pt\parsep0pt

\item

712

\item

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

713

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

\item

714

\item

{The frontend shall render the page using the help.html template.}

715

{The frontend shall render the page using the help.html template.}

\item

716

\item

{The User shall scroll to the bottom of the page.}

717

{The User shall scroll to the bottom of the page.}

\item

718

\item

{The User shall click the text reading "Send Us an Email!"}

719

{The User shall click the text reading "Send Us an Email!"}

\item

720

\item

{The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.}

721

{The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.}

\item

722

\item

{The User shall see our email address in the recipients text box.}

723

{The User shall see our email address in the recipients text box.}

\end{enumerate}

724

\end{enumerate}

\end{description}

725

\end{description}

\newpage

726

\newpage

727

{}

728

{}

\section{Flashcards}

729

\section{Flashcards}

\subsection{[F1] Push Flashcard}

730

\subsection{[F1] Push Flashcard}

731

\begin{description}

732

\begin{description}

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

733

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

input. }

734

input. }

735

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

736

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

deck and the Live Feed. }

737

deck and the Live Feed. }

\\

738

\\

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

739

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

flashcard will be shared with others. }

740

flashcard will be shared with others. }

741

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

742

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

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

743

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

\\

744

\\

\item[Pre-conditions]

745

\item[Pre-conditions]

746

\begin{itemize}

747

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

748

\itemsep1pt\parskip0pt\parsep0pt

\item

749

\item

{The User has an account.}

750

{The User has an account.}

\item

751

\item

{The User has added at least one class.}

752

{The User has added at least one class.}

\item

753

\item

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

754

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

\end{itemize}

755

\end{itemize}

756

\item[Post-conditions]

757

\item[Post-conditions]

758

\begin{itemize}

759

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

760

\itemsep1pt\parskip0pt\parsep0pt

\item

761

\item

{The User has flashcard added to their deck.}

762

{The User has flashcard added to their deck.}

\item

763

\item

{The Flashcard is shown in the Live Feed.}

764

{The Flashcard is shown in the Live Feed.}

\item

765

\item

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

766

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

\end{itemize}

767

\end{itemize}

768

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

769

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

770

\item[Workflow]

771

\item[Workflow]

772

\begin{enumerate}

773

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

774

\itemsep1pt\parskip0pt\parsep0pt

\item

775

\item

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

776

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

\item

777

\item

{The User shall click on the 'Plus' button or press the hotkey 'c'.}

778

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

\item

779

\item

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

780

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

\item

781

\item

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

782

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

\item

783

\item

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

784

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

\item

785

\item

{The User shall click on the `Contribute' button to submit the flashcard

786

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

text, blanks, and material date, in JSON form as a POST request.}

787

\item {The frontend shallsubmit the flashcard text,

788

blanks, and material date, in JSON form as a POST request.}

\item

788

789

\item

{The backend shall obtain the flashcard information by deserializing

789

790

{The backend shall obtain the flashcard information by deserializing

the JSON in the POST request in views.py.}

790

791

the JSON in the POST request in views.py.}

\item

791

792

\item

{The backend shall create a new record for this flashcard in the

792

793

{The backend shall create a new record for this flashcard in the

Flashcards table in the database in models.py.}

793

794

Flashcards table in the database in models.py.}

\item

794

795

\item

{The frontend shall publish the newly created card to the live feed of

795

796

{The frontend shall publish the newly created card to the live feed of

the class using FeedController.js.}

796

797

the class using FeedController.js.}

\end{enumerate}

797

798

\end{enumerate}

\end{description}

798

799

\end{description}

\newpage

799

800

\newpage

{}

800

801

{}

801

802

\subsection{[F2] Edit Flashcard}

802

803

\subsection{[F2] Edit Flashcard}

803

804

\begin{description}

804

805

\begin{description}

\item[Description]{The User shall be able to edit the text on their own

805

806

\item[Description]{The User shall be able to edit the text on their own

flashcard }

806

807

flashcard }

807

808

\item[Desired Outcome]{Flashcard is edited and saved appropriately.}

808

809

\item[Desired Outcome]{Flashcard is edited and saved appropriately.}

\\

809

810

\\

\item[User Goals]{To be able to change text on a flashcard.}

810

811

\item[User Goals]{To be able to change text on a flashcard.}

811

812

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

812

813

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

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

813

814

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

Flashcard}

814

815

Flashcard}

815

816

\item[Pre-conditions]

816

817

\item[Pre-conditions]

817

818

\begin{itemize}

818

819

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

819

820

\itemsep1pt\parskip0pt\parsep0pt

\item

820

821

\item

{Flashcard is created.}

821

822

{Flashcard is created.}

\item

822

823

\item

{Flashcard in user's deck.}

823

824

{Flashcard in user's deck.}

\item

824

825

\item

{Flashcard is viewable.}

825

826

{Flashcard is viewable.}

\end{itemize}

826

827

\end{itemize}

827

828

\item[Post-conditions]

828

829

\item[Post-conditions]

829

830

\begin{itemize}

830

831

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

831

832

\itemsep1pt\parskip0pt\parsep0pt

\item

832

833

\item

{Flashcard is edited.}

833

834

{Flashcard is edited.}

\end{itemize}

834

835

\end{itemize}

835

836

\item[Trigger] {The User wants to change a card to show different information.}

836

837

\item[Trigger] {The User wants to change a card to show different information.}

\item[Workflow]

837

838

\item[Workflow]

838

839

\begin{enumerate}

839

840

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

840

841

\itemsep1pt\parskip0pt\parsep0pt

\item{User has clicked ``Edit'' button when viewing a specific flashcard.}

841

842

\item{User has clicked ``Edit'' button when viewing a specific flashcard.}

\item

842

843

\item

{The frontend shall produce an editable dialog box containing flashcard

843

844

{The frontend shall produce an editable dialog box containing flashcard

text }

844

845

text }

\item

845

846

\item

{The user shall make desired changes}

846

847

{The user shall make desired changes}

\item

847

848

\item

{The user shall click `Save'}

848

849

{The user shall click `Save'}

\item

849

850

\item

{The client shall generate a POST request for a new flashcard and send

850

851

{The client shall generate a POST request for a new flashcard and send

it to the server}

851

852

it to the server}

\item

852

853

\item

{If the user changed only the blanks of the cards, the server shall

853

854

{If the user changed only the blanks of the cards, the server shall

create a new FlashcardMask object and update the appropriate

854

855

create a new FlashcardMask object and update the appropriate

UserFlashcard object with a reference to it.}

855

856

UserFlashcard object with a reference to it.}

\item

856

857

\item

{If the user changed the text of the card, the server will instead:}

857

858

{If the user changed the text of the card, the server will instead:}

\end{enumerate}

858

859

\end{enumerate}

859

860

\begin{enumerate}

860

861

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

861

862

\itemsep1pt\parskip0pt\parsep0pt

\item

862

863

\item

{create a new flashcard for the section}

863

864

{create a new flashcard for the section}

\item

864

865

\item

{push it to the feed}

865

866

{push it to the feed}

\item

866

867

\item

{add it to the user's deck}

867

868

{add it to the user's deck}

\item

868

869

\item

{hide the old card from the user}

869

870

{hide the old card from the user}

\item

870

871

\item

{and return the new card to the user}

871

872

{and return the new card to the user}

\end{enumerate}

872

873

\end{enumerate}

\end{description}

873

874

\end{description}

{}

874

875

{}

875

876

\newpage

876

877

\newpage

877

878

{}

878

879

{}

879

880

\subsection{[F3] Pull Flashcard}

880

881

\subsection{[F3] Pull Flashcard}

\begin{description}

881

882

\begin{description}

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

882

883

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

deck from the Live Feed. }

883

884

deck from the Live Feed. }

884

885

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

885

886

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

deck }

886

887

deck }

\\

887

888

\\

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

888

889

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

889

890

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

890

891

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

891

892

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

892

893

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

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

893

894

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

\\

894

895

\\

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

895

896

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

896

897

\item[Status]{Implemented}

897

898

\item[Status]{Implemented}

898

899

\item[Pre-conditions]

899

900

\item[Pre-conditions]

900

901

\begin{itemize}

901

902

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

902

903

\itemsep1pt\parskip0pt\parsep0pt

\item

903

904

\item

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

904

905

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

\item

905

906

\item

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

906

907

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

\end{itemize}

907

908

\end{itemize}

908

909

\item[Post-conditions]

909

910

\item[Post-conditions]

910

911

\begin{itemize}

911

912

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

912

913

\itemsep1pt\parskip0pt\parsep0pt

\item

913

914

\item

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

914

915

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

\item

915

916

\item

{User can review this flashcard later.}

916

917

{User can review this flashcard later.}

\end{itemize}

917

918

\end{itemize}

918

919

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

919

920

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

920

921

\item[Workflow]

921

922

\item[Workflow]

922

923

\begin{enumerate}

923

924

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

924

925

\itemsep1pt\parskip0pt\parsep0pt

\item

925

926

\item

{User shall click on the ``Pull Flashcard'' button on a Flashcard in

926

927

{User shall click on the ``Pull Flashcard'' button on a Flashcard in

the Feed.}

927

928

the Feed.}

\item

928

929

\item

{The frontend shall }

929

930

{The frontend shall }

\item

930

931

\item

{The Client shall make the pulled Flashcard appear in the User's Deck

931

932

{The Client shall make the pulled Flashcard appear in the User's Deck

on the sidebar.}

932

933

on the sidebar.}

\item

933

934

\item

{The Client shall submit a POST request to

934

935

{The Client shall submit a POST request to

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

935

936

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

\item

936

937

\item

{The server shall create a UserFlashcard object to represent that the

937

938

{The server shall create a UserFlashcard object to represent that the

user's deck contains the card.}

938

939

user's deck contains the card.}

\item

939

940

\item

{The server shall notify connected clients about the new card rating,

940

941

{The server shall notify connected clients about the new card rating,

if any}

941

942

if any}

\item

942

943

\item

{Connected clients will take the new rating into account when next

943

944

{Connected clients will take the new rating into account when next

rearranging the feed.}

944

945

rearranging the feed.}

\end{enumerate}

945

946

\end{enumerate}

\end{description}

946

947

\end{description}

\newpage

947

948

\newpage

948

949

{}

949

950

{}

950

951

\subsection{[F4] Flag Inappropriate Cards}

951

952

\subsection{[F4] Flag Inappropriate Cards}

952

953

\begin{description}

953

954

\begin{description}

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

954

955

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

955

956

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

956

957

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

adjusted.}

957

958

adjusted.}

\\

958

959

\\

\item[User Goals]{To note if a card should not belong in the class and

959

960

\item[User Goals]{To note if a card should not belong in the class and

should not be displayed in the feed.}

960

961

should not be displayed in the feed.}

961

962

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

962

963

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

963

964

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

964

965

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

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

965

966

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

\\

966

967

\\

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

967

968

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

968

969

\item[Status]{Implemented}

969

970

\item[Status]{Implemented}

970

971

\item[Pre-conditions]

971

972

\item[Pre-conditions]

972

973

\begin{itemize}

973

974

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

974

975

\itemsep1pt\parskip0pt\parsep0pt

\item

975

976

\item

{User is enrolled in a class}

976

977

{User is enrolled in a class}

\end{itemize}

977

978

\end{itemize}

978

979

\begin{itemize}

979

980

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

980

981

\itemsep1pt\parskip0pt\parsep0pt

\item

981

982

\item

{Flashcard is created.}

982

983

{Flashcard is created.}

\item

983

984

\item

{Flashcard is viewable in feed.}

984

985

{Flashcard is viewable in feed.}

\item

985

986

\item

{The User has clicked the red button on the flashcard which is the "Hide Card" button.}

986

987

{The User has clicked the red button on the flashcard which is the "Hide Card" button.}

\end{itemize}

987

988

\end{itemize}

988

989

\item[Post-conditions]

989

990

\item[Post-conditions]

990

991

\begin{itemize}

991

992

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

992

993

\itemsep1pt\parskip0pt\parsep0pt

\item

993

994

\item

{Flashcard is hidden from user.}

994

995

{Flashcard is hidden from user.}

\item

995

996

\item

{Flashcard internal variable is adjusted.}

996

997

{Flashcard internal variable is adjusted.}

\end{itemize}

997

998

\end{itemize}

998

999

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

999

1000

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

1000

1001

\item[Workflow]

1001

1002

\item[Workflow]

1002

1003

\begin{enumerate}

1003

1004

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1004

1005

\itemsep1pt\parskip0pt\parsep0pt

\item {

1005

1006

\item {

The frontend displays a toast that offers the User the report text.}

1006

1007

The frontend displays a toast that offers the User the report text.}

\item

1007

1008

\item

{The User clicks the ``Report'' text on the flashcard.}

1008

1009

{The User clicks the ``Report'' text on the flashcard.}

\item

1009

1010

\item

{The frontend shall hide the flashcard from the User.}

1010

1011

{The frontend shall hide the flashcard from the User.}

\item

1011

1012

\item

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

1012

1013

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

\item

1013

1014

\item

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

1014

1015

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

\end{enumerate}

1015

1016

\end{enumerate}

\end{description}

1016

1017

\end{description}

{}

1017

1018

{}

1018

1019

{}

1019

1020

{}

1020

1021

\newpage

1021

1022

\newpage

1022

1023

{}

1023

1024

{}

1024

1025

\subsection{[F5] Filter Flashcards - Deferred}

1025

1026

\subsection{[F5] Filter Flashcards - Deferred}

1026

1027

\begin{description}

1027

1028

\begin{description}

\item[Description]{The User is able to filter for flashcards by date.}

1028

1029

\item[Description]{The User is able to filter for flashcards by date.}

1029

1030

\item[Desired Outcome]{The User shall see flashcards based on the filter

1030

1031

\item[Desired Outcome]{The User shall see flashcards based on the filter

options.}

1031

1032

options.}

1032

1033

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

1033

1034

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

for.}

1034

1035

for.}

1035

1036

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

1036

1037

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

1037

1038

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

1038

1039

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

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

1039

1040

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

Flashcard}

1040

1041

Flashcard}

\\

1041

1042

\\

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

1042

1043

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

1043

1044

\item[Status]{Not Implemented }

1044

1045

\item[Status]{Not Implemented }

1045

1046

\item[Pre-conditions]

1046

1047

\item[Pre-conditions]

1047

1048

\begin{itemize}

1048

1049

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1049

1050

\itemsep1pt\parskip0pt\parsep0pt

\item

1050

1051

\item

{User has added the class.}

1051

1052

{User has added the class.}

\item

1052

1053

\item

{Flashcards exist in the course.}

1053

1054

{Flashcards exist in the course.}

\item

1054

1055

\item

{The User has navigated to the study page.}

1055

1056

{The User has navigated to the study page.}

\end{itemize}

1056

1057

\end{itemize}

1057

1058

\item[Post-conditions]{}

1058

1059

\item[Post-conditions]{}

1059

1060

\begin{itemize}

1060

1061

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1061

1062

\itemsep1pt\parskip0pt\parsep0pt

\item

1062

1063

\item

{User only sees specific flashcards}

1063

1064

{User only sees specific flashcards}

\end{itemize}

1064

1065

\end{itemize}

1065

1066

\item[Trigger]{The User wants to only see cards for a specific date range.}

1066

1067

\item[Trigger]{The User wants to only see cards for a specific date range.}

1067

1068

\item[Workflow]

1068

1069

\item[Workflow]

1069

1070

\begin{enumerate}

1070

1071

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1071

1072

\itemsep1pt\parskip0pt\parsep0pt

\item

1072

1073

\item

{The frontend shall render the page described in study.html.}

1073

1074

{The frontend shall render the page described in study.html.}

\item

1074

1075

\item

{The User fills in the date fields.}

1075

1076

{The User fills in the date fields.}

\item

1076

1077

\item

{The frontend checks the date fields before making the POST request to /api/study.}

1077

1078

{The frontend checks the date fields before making the POST request to /api/study.}

\item

1078

1079

\item

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

1079

1080

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

1080

1081

\end{enumerate}

1081

1082

\end{enumerate}

\end{description}

1082

1083

\end{description}

{}

1083

1084

{}

1084

1085

\newpage

1085

1086

\newpage

1086

1087

{}

1087

1088

{}

1088

1089

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

1089

1090

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

1090

1091

\begin{description}

1091

1092

\begin{description}

\item[Description]{The User shall be able to blank out keywords in any

1092

1093

\item[Description]{The User shall be able to blank out keywords in any

flashcard in his deck. }

1093

1094

flashcard in his deck. }

1094

1095

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

1095

1096

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

System that they are keywords. }

1096

1097

System that they are keywords. }

\\

1097

1098

\\

\item[User Goals]{The User shall mark some words as keywords so the System

1098

1099

\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

1099

1100

may later quiz theirself by blanking out the keywords and having the

User guess what they are.}

1100

1101

User guess what they are.}

1101

1102

{Primary Actor: }{User (student)}

1102

1103

{Primary Actor: }{User (student)}

1103

1104

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

1104

1105

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

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

1105

1106

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

\\

1106

1107

\\

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

1107

1108

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

1108

1109

\item[Status]{Not implemented.}

1109

1110

\item[Status]{Not implemented.}

1110

1111

\item[Pre-conditions]

1111

1112

\item[Pre-conditions]

1112

1113

\begin{itemize}

1113

1114

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1114

1115

\itemsep1pt\parskip0pt\parsep0pt

\item

1115

1116

\item

{The User has the flashcard he wishes to blank out words from in his

1116

1117

{The User has the flashcard he wishes to blank out words from in his

deck.}

1117

1118

deck.}

\item

1118

1119

\item

{The User shall (be on the class page and) view deck}

1119

1120

{The User shall (be on the class page and) view deck}

\end{itemize}

1120

1121

\end{itemize}

1121

1122

{Post-conditions: }

1122

1123

{Post-conditions: }

1123

1124

\begin{itemize}

1124

1125

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1125

1126

\itemsep1pt\parskip0pt\parsep0pt

\item

1126

1127

\item

{The blanked out words in the flashcard are marked as keywords.}

1127

1128

{The blanked out words in the flashcard are marked as keywords.}

\item

1128

1129

\item

{The System shall blank out the keywords and let the User guess what

1129

1130

{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.}

1130

1131

they are when it presents the flashcard to the User for reviewing.}

\end{itemize}

1131

1132

\end{itemize}

1132

1133

\item[Trigger]{The User clicks on a flashcard.}

1133

1134

\item[Trigger]{The User clicks on a flashcard.}

1134

1135

\item[Workflow]

1135

1136

\item[Workflow]

1136

1137

\begin{enumerate}

1137

1138

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1138

1139

\itemsep1pt\parskip0pt\parsep0pt

\item

1139

1140

\item

{The Client shall a show deck to user}

1140

1141

{The Client shall a show deck to user}

\item

1141

1142

\item

{The User shall click on the flashcard in his deck that he wants to

1142

1143

{The User shall click on the flashcard in his deck that he wants to

blank out words from}

1143

1144

blank out words from}

\item

1144

1145

\item

{The client shall bring user to edit flashcard page/popup}

1145

1146

{The client shall bring user to edit flashcard page/popup}

\item

1146

1147

\item

{The User shall click on the words that he wishes to blank out}

1147

1148

{The User shall click on the words that he wishes to blank out}

\item

1148

1149

\item

{The client shall specify a character range as blank}

1149

1150

{The client shall specify a character range as blank}

\item

1150

1151

\item

{The server shall mark those words by updating the Flashcard Mask for

1151

1152

{The server shall mark those words by updating the Flashcard Mask for

that flashcard. }

1152

1153

that flashcard. }

\item

1153

1154

\item

{The User shall click on `Save' or the equivalent button to save the

1154

1155

{The User shall click on `Save' or the equivalent button to save the

changes}

1155

1156

changes}

\item

1156

1157

\item

{The server will save the blanked out words as keywords to the

1157

1158

{The server will save the blanked out words as keywords to the

Flashcard Mask to review}

1158

1159

Flashcard Mask to review}

\item

1159

1160

\item

{The client shall cover the keywords with whitespace to hide them from

1160

1161

{The client shall cover the keywords with whitespace to hide them from

the User}

1161

1162

the User}

\end{enumerate}

1162

1163

\end{enumerate}

1163

1164

{Alternative Workflows:}

1164

1165

{Alternative Workflows:}

1165

1166

\begin{enumerate}

1166

1167

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1167

1168

\itemsep1pt\parskip0pt\parsep0pt

\item

1168

1169

\item

{The User shall (be on the class page and) click ``Make New

1169

1170

{The User shall (be on the class page and) click ``Make New

Flashcard''}

1170

1171

Flashcard''}

\item

1171

1172

\item

{The client shall present user with a new flashcard to fill in}

1172

1173

{The client shall present user with a new flashcard to fill in}

\item

1173

1174

\item

{The User shall fill in the information}

1174

1175

{The User shall fill in the information}

\item

1175

1176

\item

{The client shall ask if the user wants to specify blanks}

1176

1177

{The client shall ask if the user wants to specify blanks}

\item

1177

1178

\item

{The System will save the blanked out words as keywords to the

1178

1179

{The System will save the blanked out words as keywords to the

Flashcard Mask to review}

1179

1180

Flashcard Mask to review}

\item

1180

1181

\item

{The client shall cover the keywords with whitespace to hide them from

1181

1182

{The client shall cover the keywords with whitespace to hide them from

the User}

1182

1183

the User}

\end{enumerate}

1183

1184

\end{enumerate}

\end{description}

1184

1185

\end{description}

{}

1185

1186

{}

1186

1187

\newpage

1187

1188

\newpage

1188

1189

{}

1189

1190

{}

1190

1191

\subsection{[F7] Fix Flashcard}

1191

1192

\subsection{[F7] Fix Flashcard}

1192

1193

\begin{description}

1193

1194

\begin{description}

\item[Description]{The User shall be able to alter a flashcard he/she made

1194

1195

\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.}

1195

1196

originally and not have to make a new copy of it.}

1196

1197

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

1197

1198

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

alteration will be shown to all users of that flashcard}

1198

1199

alteration will be shown to all users of that flashcard}

\\

1199

1200

\\

\item[User Goals]{The user shall make the flashcard say something different

1200

1201

\item[User Goals]{The user shall make the flashcard say something different

than it did originally.}

1201

1202

than it did originally.}

1202

1203

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

1203

1204

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

1204

1205

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

1205

1206

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

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

1206

1207

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

\\

1207

1208

\\

\item[Priority Level]{Must}

1208

1209

\item[Priority Level]{Must}

1209

1210

\item[Status]{Not Implemented}

1210

1211

\item[Status]{Not Implemented}

1211

1212

\item[Pre-conditions]

1212

1213

\item[Pre-conditions]

1213

1214

\begin{itemize}

1214

1215

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1215

1216

\itemsep1pt\parskip0pt\parsep0pt

\item

1216

1217

\item

{User has created the flashcard}

1217

1218

{User has created the flashcard}

\end{itemize}

1218

1219

\end{itemize}

1219

1220

\item[Post-conditions]{}

1220

1221

\item[Post-conditions]{}

1221

1222

\begin{itemize}

1222

1223

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1223

1224

\itemsep1pt\parskip0pt\parsep0pt

\item

1224

1225

\item

{The user shall see their alteration for that flashcard}

1225

1226

{The user shall see their alteration for that flashcard}

\item

1226

1227

\item

{Other users will be notified of the alteration}

1227

1228

{Other users will be notified of the alteration}

\end{itemize}

1228

1229

\end{itemize}

1229

1230

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

1230

1231

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

``Edit''}

1231

1232

``Edit''}

1232

1233

\item[Workflow]

1233

1234

\item[Workflow]

1234

1235

\begin{enumerate}

1235

1236

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1236

1237

\itemsep1pt\parskip0pt\parsep0pt

\item

1237

1238

\item

{User shall select one of the Flashcards they authored.}

1238

1239

{User shall select one of the Flashcards they authored.}

\item

1239

1240

\item

{User shall select ``Edit'' button on the flashcard.}

1240

1241

{User shall select ``Edit'' button on the flashcard.}

\item

1241

1242

\item

{Client shall display an ``Edit Flashcard'' view.}

1242

1243

{Client shall display an ``Edit Flashcard'' view.}

\item

1243

1244

\item

{The Flashcard will display editable fields/areas.}

1244

1245

{The Flashcard will display editable fields/areas.}

\item

1245

1246

\item

{The User shall input any changes to the Flashcard.}

1246

1247

{The User shall input any changes to the Flashcard.}

\item

1247

1248

\item

{The User shall select the ``Done Editing'' button.}

1248

1249

{The User shall select the ``Done Editing'' button.}

\item

1249

1250

\item

{The Client shall close the ``Edit Flashcard'' view.}

1250

1251

{The Client shall close the ``Edit Flashcard'' view.}

\item

1251

1252

\item

{The server shall update the Flashcard's content.}

1252

1253

{The server shall update the Flashcard's content.}

\item

1253

1254

\item

{Client shall notify users with the Flashcard that the Flashcard has

1254

1255

{Client shall notify users with the Flashcard that the Flashcard has

been edited, allowing the other users to keep or to discard the

1255

1256

been edited, allowing the other users to keep or to discard the

changes.}

1256

1257

changes.}

\end{enumerate}

1257

1258

\end{enumerate}

\end{description}

1258

1259

\end{description}

{}

1259

1260

{}

1260

1261

{}

1261

1262

{}

1262

1263

{}

1263

1264

{}

1264

1265

\newpage

1265

1266

\newpage

1266

1267

{}

1267

1268

{}

1268

1269

\subsection{[F8] Hide cards from feed}

1269

1270

\subsection{[F8] Hide cards from feed}

1270

1271

\begin{description}

1271

1272

\begin{description}

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

1272

1273

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

1273

1274

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

1274

1275

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

\\

1275

1276

\\

\item[User Goals]{The card has been looked at and should be hidden to

1276

1277

\item[User Goals]{The card has been looked at and should be hidden to

reduce screen clutter}

1277

1278

reduce screen clutter}

1278

1279

{Primary Actor: }{User (Student)}

1279

1280

{Primary Actor: }{User (Student)}

1280

1281

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

1281

1282

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

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

1282

1283

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

\\

1283

1284

\\

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

1284

1285

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

1285

1286

{Status:}{Not implemented}

1286

1287

{Status:}{Not implemented}

1287

1288

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

1288

1289

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

1289

1290

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

1290

1291

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

1291

1292

\item[Trigger]{Card is flagged; Card is noted to be hidden}

1292

1293

\item[Trigger]{Card is flagged; Card is noted to be hidden}

1293

1294

\item[Workflow]

1294

1295

\item[Workflow]

1295

1296

\begin{enumerate}

1296

1297

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1297

1298

\itemsep1pt\parskip0pt\parsep0pt

\item

1298

1299

\item

{The User chooses a class from the dashboard.}

1299

1300

{The User chooses a class from the dashboard.}

\item

1300

1301

\item

{The Client shows the Live Feed for the selected class.}

1301

1302

{The Client shows the Live Feed for the selected class.}

\item

1302

1303

\item

{The User sees a card they want to hide from the Live Feed.}

1303

1304

{The User sees a card they want to hide from the Live Feed.}

\item

1304

1305

\item

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

1305

1306

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

hidden.}

1306

1307

hidden.}

\item

1307

1308

\item

{The Client shall hide the card of interest from the Live Feed, for

1308

1309

{The Client shall hide the card of interest from the Live Feed, for

only that User.}

1309

1310

only that User.}

\end{enumerate}

1310

1311

\end{enumerate}

1311

1312

\end{description}

1312

1313

\end{description}

1313

1314

\newpage

1314

1315

\newpage

1315

1316

{}

1316

1317

{}

1317

1318

\subsection{[F9] View a Feed}

1318

1319

\subsection{[F9] View a Feed}

1319

1320

\begin{description}

1320

1321

\begin{description}

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

1321

1322

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

classes}

1322

1323

classes}

1323

1324

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

1324

1325

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

specific classes. }

1325

1326

specific classes. }

\\

1326

1327

\\

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

1327

1328

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

1328

1329

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

1329

1330

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

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

1330

1331

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

\\

1331

1332

\\

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

1332

1333

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

1333

1334

{Status:}{Not implemented}

1334

1335

{Status:}{Not implemented}

1335

1336

\item[Pre-conditions]{User has added a class}

1336

1337

\item[Pre-conditions]{User has added a class}

1337

1338

\item[Post-conditions]{User shall see the Live Feed for that class}

1338

1339

\item[Post-conditions]{User shall see the Live Feed for that class}

1339

1340

\item[Trigger]{User shall select a class}

1340

1341

\item[Trigger]{User shall select a class}

1341

1342

\item[Workflow]

1342

1343

\item[Workflow]

1343

1344

\begin{enumerate}

1344

1345

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1345

1346

\itemsep1pt\parskip0pt\parsep0pt

\item

1346

1347

\item

{The User logs into their account.}

1347

1348

{The User logs into their account.}

\item

1348

1349

\item

{The System verifies the User's credentials and saves their session.}

1349

1350

{The System verifies the User's credentials and saves their session.}

\item

1350

1351

\item

{The User is at their dashboard.}

1351

1352

{The User is at their dashboard.}

\item

1352

1353

\item

{The Client shows the User's dashboard.}

1353

1354

{The Client shows the User's dashboard.}

\item

1354

1355

\item

{The User selects a class from their dashboard.}

1355

1356

{The User selects a class from their dashboard.}

\item

1356

1357

\item

{The Client displays the Live Feed for the class.}

1357

1358

{The Client displays the Live Feed for the class.}

\end{enumerate}

1358

1359

\end{enumerate}

1359

1360

\end{description}

1360

1361

\end{description}

\newpage

1361

1362

\newpage

1362

1363

{}

1363

1364

{}

\section{Decks}

1364

1365

\section{Decks}

\subsection{[-D2-] Making a deck}

1365

1366

\subsection{[-D2-] Making a deck}

1366

1367

\begin{description}

1367

1368

\begin{description}

\item[Description]{Upon selecting the right course, the student has the

1368

1369

\item[Description]{Upon selecting the right course, the student has the

power to make a deck by either selecting existing flashcard or adding a

1369

1370

power to make a deck by either selecting existing flashcard or adding a

new flashcard.}

1370

1371

new flashcard.}

1371

1372

\item[Desired Outcome]{The user can keep track of cards that s/he wants.}

1372

1373

\item[Desired Outcome]{The user can keep track of cards that s/he wants.}

\\

1373

1374

\\

\item[User Goals]{The user has a personal deck ready for review later.}

1374

1375

\item[User Goals]{The user has a personal deck ready for review later.}

1375

1376

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

1376

1377

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

1377

1378

\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck

1378

1379

\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck

{[}F1{]}, Make a Flashcard {[}F3{]}}

1379

1380

{[}F1{]}, Make a Flashcard {[}F3{]}}

\\

1380

1381

\\

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

1381

1382

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

1382

1383

\item[Status]{In Progress}

1383

1384

\item[Status]{In Progress}

1384

1385

\item[Pre-conditions]

1385

1386

\item[Pre-conditions]

1386

1387

\begin{itemize}

1387

1388

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1388

1389

\itemsep1pt\parskip0pt\parsep0pt

\item

1389

1390

\item

{The user has an account with the application. }

1390

1391

{The user has an account with the application. }

\item

1391

1392

\item

{The user has been added to the desired class.}

1392

1393

{The user has been added to the desired class.}

\end{itemize}

1393

1394

\end{itemize}

1394

1395

\item[Post-conditions]

1395

1396

\item[Post-conditions]

1396

1397

\begin{itemize}

1397

1398

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1398

1399

\itemsep1pt\parskip0pt\parsep0pt

\item

1399

1400

\item

{Desired cards are added to user's deck to the specific class }

1400

1401

{Desired cards are added to user's deck to the specific class }

\item

1401

1402

\item

{User's deck is added to the database.}

1402

1403

{User's deck is added to the database.}

\end{itemize}

1403

1404

\end{itemize}

1404

1405

\item[Trigger]{User has selected a card from the pool. User submitted a

1405

1406

\item[Trigger]{User has selected a card from the pool. User submitted a

new flashcard after ``Make New Flashcard''.}

1406

1407

new flashcard after ``Make New Flashcard''.}

1407

1408

\item[Workflow]

1408

1409

\item[Workflow]

1409

1410

\begin{enumerate}

1410

1411

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1411

1412

\itemsep1pt\parskip0pt\parsep0pt

\item

1412

1413

\item

{User is at their dashboard.}

1413

1414

{User is at their dashboard.}

\item

1414

1415

\item

{User selects the class of interest that they had no activity in yet.}

1415

1416

{User selects the class of interest that they had no activity in yet.}

\item

1416

1417

\item

{Client displays the Live Feed for the class.}

1417

1418

{Client displays the Live Feed for the class.}

\item

1418

1419

\item

{User presses ``Pull Flashcard'' button on a Flashcard that they want

1419

1420

{User presses ``Pull Flashcard'' button on a Flashcard that they want

in their Deck.}

1420

1421

in their Deck.}

\item

1421

1422

\item

{The server creates a Deck for the User for the Class of interest.}

1422

1423

{The server creates a Deck for the User for the Class of interest.}

\item

1423

1424

\item

{The server adds the Flashcard to the User's Deck.}

1424

1425

{The server adds the Flashcard to the User's Deck.}

\item

1425

1426

\item

{The Client makes the Flashcard disappear from the Live Feed.}

1426

1427

{The Client makes the Flashcard disappear from the Live Feed.}

\item

1427

1428

\item

{The Client displays the Flashcard in the User's Deck in the sidebar.}

1428

1429

{The Client displays the Flashcard in the User's Deck in the sidebar.}

\end{enumerate}

1429

1430

\end{enumerate}

1430

1431

{Alternate Workflow:}

1431

1432

{Alternate Workflow:}

1432

1433

\begin{enumerate}

1433

1434

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1434

1435

\itemsep1pt\parskip0pt\parsep0pt

\item

1435

1436

\item

{User is at their dashboard.}

1436

1437

{User is at their dashboard.}

\item

1437

1438

\item

{User selects the class of interest that they had no activity in yet.}

1438

1439

{User selects the class of interest that they had no activity in yet.}

\item

1439

1440

\item

{Client displays the Live Feed for the class.}

1440

1441

{Client displays the Live Feed for the class.}

\item

1441

1442

\item

{The User adds a Flashcard into the Class.}

1442

1443

{The User adds a Flashcard into the Class.}

\item

1443

1444

\item

{The server creates a Deck for the User for the Class of interest.}

1444

1445

{The server creates a Deck for the User for the Class of interest.}

\item

1445

1446

\item

{The server adds the new Flashcard to the User's Deck.}

1446

1447

{The server adds the new Flashcard to the User's Deck.}

\item

1447

1448

\item

{The Client makes the Flashcard disappear from the Live Feed.}

1448

1449

{The Client makes the Flashcard disappear from the Live Feed.}

\item

1449

1450

\item

{The Client displays the Flashcard in the User's Deck in the sidebar.}

1450

1451

{The Client displays the Flashcard in the User's Deck in the sidebar.}

\end{enumerate}

1451

1452

\end{enumerate}

\end{description}

1452

1453

\end{description}

\newpage

1453

1454

\newpage

1454

1455

{}

1455

1456

{}

1456

1457

\subsection{[D1] Remove a card from a deck}

1457

1458

\subsection{[D1] Remove a card from a deck}

1458

1459

\begin{description}

1459

1460

\begin{description}

\item[Description]{The user can remove flashcards from their deck.}

1460

1461

\item[Description]{The user can remove flashcards from their deck.}

1461

1462

\item[Desired Outcome]{The user will not be notified about that card. }

1462

1463

\item[Desired Outcome]{The user will not be notified about that card. }

\\

1463

1464

\\

\item[User Goals]{To only review cards that the user wants to review. }

1464

1465

\item[User Goals]{To only review cards that the user wants to review. }

1465

1466

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

1466

1467

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

1467

1468

\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck

1468

1469

\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck

{[}F1{]}, Make a Flashcard {[}F3{]}}

1469

1470

{[}F1{]}, Make a Flashcard {[}F3{]}}

\\

1470

1471

\\

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

1471

1472

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

1472

1473

\item[Status]{Unimplemented}

1473

1474

\item[Status]{Unimplemented}

1474

1475

\item[Pre-conditions]

1475

1476

\item[Pre-conditions]

1476

1477

\begin{itemize}

1477

1478

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1478

1479

\itemsep1pt\parskip0pt\parsep0pt

\item

1479

1480

\item

{The User has an account with the application}

1480

1481

{The User has an account with the application}

\item

1481

1482

\item

{The User is logged in}

1482

1483

{The User is logged in}

\end{itemize}

1483

1484

\end{itemize}

1484

1485

\item[Post-conditions]

1485

1486

\item[Post-conditions]

1486

1487

\begin{itemize}

1487

1488

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1488

1489

\itemsep1pt\parskip0pt\parsep0pt

\item

1489

1490

\item

{Desired cards are hidden to the user.}

1490

1491

{Desired cards are hidden to the user.}

\end{itemize}

1491

1492

\end{itemize}

1492

1493

\item[Trigger]{User has selected a card to be hidden.}

1493

1494

\item[Trigger]{User has selected a card to be hidden.}

1494

1495

\item[Workflow]

1495

1496

\item[Workflow]

1496

1497

\begin{enumerate}

1497

1498

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1498

1499

\itemsep1pt\parskip0pt\parsep0pt

\item

1499

1500

\item

{The Client shows the user the dashboard.}

1500

1501

{The Client shows the user the dashboard.}

\item

1501

1502

\item

{The User shall select the appropriate class.}

1502

1503

{The User shall select the appropriate class.}

\item

1503

1504

\item

{The System checks if the class is in session.}

1504

1505

{The System checks if the class is in session.}

\item

1505

1506

\item

{The User shall select deck view.}

1506

1507

{The User shall select deck view.}

\item

1507

1508

\item

{The Client shall route the user to the deck view.}

1508

1509

{The Client shall route the user to the deck view.}

\item

1509

1510

\item

{The User clicks a flashcard's remove button.}

1510

1511

{The User clicks a flashcard's remove button.}

\item

1511

1512

\item

{The Client shall send a DELETE request to the server}{}{at

1512

1513

{The Client shall send a DELETE request to the server}{}{at

/api/flashcard/\textless{}flashcard ID\textgreater{}/remove}

1513

1514

/api/flashcard/\textless{}flashcard ID\textgreater{}/remove}

\item

1514

1515

\item

{The Server removes the flashcard from the User's Deck.}

1515

1516

{The Server removes the flashcard from the User's Deck.}

\item

1516

1517

\item

{The Server updates the flashcard's position in the Live Feed.}

1517

1518

{The Server updates the flashcard's position in the Live Feed.}

\item

1518

1519

\item

{The Client updates the User's Deck.}

1519

1520

{The Client updates the User's Deck.}

\end{enumerate}

1520

1521

\end{enumerate}

1521

1522

{}

1522

1523

{}

1523

1524

{Alternate Workflow:}

1524

1525

{Alternate Workflow:}

1525

1526

\begin{enumerate}

1526

1527

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1527

1528

\itemsep1pt\parskip0pt\parsep0pt

\item

1528

1529

\item

{The Client shows the user the dashboard.}

1529

1530

{The Client shows the user the dashboard.}

\item

1530

1531

\item

{The User shall select the appropriate class.}

1531

1532

{The User shall select the appropriate class.}

\item

1532

1533

\item

{The System checks if the class is }{not}{in session.}

1533

1534

{The System checks if the class is }{not}{in session.}

\item

1534

1535

\item

{The Client shall the user to the deck view.}

1535

1536

{The Client shall the user to the deck view.}

\item

1536

1537

\item

{The User clicks a flashcard's remove button.}

1537

1538

{The User clicks a flashcard's remove button.}

\item

1538

1539

\item

{The Client shall send a DELETE request to the server}{}{at

1539

1540

{The Client shall send a DELETE request to the server}{}{at

/api/flashcard/\textless{}flashcard ID\textgreater{}/remove}

1540

1541

/api/flashcard/\textless{}flashcard ID\textgreater{}/remove}

\item

1541

1542

\item

{The Server removes the flashcard from the User's Deck.}

1542

1543

{The Server removes the flashcard from the User's Deck.}

\item

1543

1544

\item

{The Server updates the flashcard's position in the Live Feed.}

1544

1545

{The Server updates the flashcard's position in the Live Feed.}

\item

1545

1546

\item

{The Client updates the User's Deck.}

1546

1547

{The Client updates the User's Deck.}

\end{enumerate}

1547

1548

\end{enumerate}

\end{description}

1548

1549

\end{description}

1549

1550

\subsection{[-D2-] Shuffling deck}

1550

1551

\subsection{[-D2-] Shuffling deck}

1551

1552

\begin{description}

1552

1553

\begin{description}

\item[Description]{User is able to shuffle his/her deck as a way to study

1553

1554

\item[Description]{User is able to shuffle his/her deck as a way to study

the flashcards}

1554

1555

the flashcards}

1555

1556

\item[Desired Outcome]{When taking a quiz, the user will notice that

1556

1557

\item[Desired Outcome]{When taking a quiz, the user will notice that

flashcards appear in random order}

1557

1558

flashcards appear in random order}

1558

1559

{User Goals:}{Improve quiz taking skills and knowledge consumption}

1559

1560

{User Goals:}{Improve quiz taking skills and knowledge consumption}

1560

1561

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

1561

1562

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

1562

1563

\item[Dependency Use Cases]{Deck has been created {[}D2{]}}

1563

1564

\item[Dependency Use Cases]{Deck has been created {[}D2{]}}

\\

1564

1565

\\

\item[Priority Level]{}{''Won't''}

1565

1566

\item[Priority Level]{}{''Won't''}

1566

1567

\item[Status]{Implemented }

1567

1568

\item[Status]{Implemented }

1568

1569

\item[Pre-conditions]

1569

1570

\item[Pre-conditions]

1570

1571

\begin{itemize}

1571

1572

\begin{itemize}

GITLAB

110swag / docs

Fixed F1