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 that presents a toast reading "Help" when the User hovers over it.}

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 'Plus' button or press the hotkey 'c'.}

\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 to submit the flashcard

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

787

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

\item

788

\item

{The backend shall obtain the flashcard information by deserializing

789

{The backend shall obtain the flashcard information by deserializing

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

790

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

\item

791

\item

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

792

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

Flashcards table in the database in models.py.}

793

Flashcards table in the database in models.py.}

\item

794

\item

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

795

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

the class using FeedController.js.}

796

the class using FeedController.js.}

\end{enumerate}

797

\end{enumerate}

\end{description}

798

\end{description}

\newpage

799

\newpage

{}

800

{}

801

\subsection{[F2] Edit Flashcard}

802

\subsection{[F2] Edit Flashcard}

803

\begin{description}

804

\begin{description}

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

805

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

flashcard }

806

flashcard }

807

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

808

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

\\

809

\\

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

810

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

811

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

812

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

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

813

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

Flashcard}

814

Flashcard}

815

\item[Pre-conditions]

816

\item[Pre-conditions]

817

\begin{itemize}

818

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

819

\itemsep1pt\parskip0pt\parsep0pt

\item

820

\item

{Flashcard is created}

821

{Flashcard is created}

\item

822

\item

{Flashcard in user's deck}

823

{Flashcard in user's deck}

\item

824

\item

{Flashcard is viewable}

825

{Flashcard is viewable}

\end{itemize}

826

\end{itemize}

827

\item[Post-conditions]

828

\item[Post-conditions]

829

\begin{itemize}

830

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

831

\itemsep1pt\parskip0pt\parsep0pt

\item

832

\item

{Flashcard is edited}

833

{Flashcard is edited}

\end{itemize}

834

\end{itemize}

835

\item[Trigger]{User has clicked ``Edit'' button when viewing a specific

836

\item[Trigger]{User has clicked ``Edit'' button when viewing a specific

flashcard}

837

flashcard}

838

\item[Workflow]

839

\item[Workflow]

840

\begin{enumerate}

841

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

842

\itemsep1pt\parskip0pt\parsep0pt

\item

843

\item

{The user shall view their deck}

844

{The user shall view their deck}

\item

845

\item

{The client shall present user with a grid view of cards in

846

{The client shall present user with a grid view of cards in

chronological creation order}

847

chronological creation order}

\item

848

\item

{The user shall select a flashcard and click `Edit'}

849

{The user shall select a flashcard and click `Edit'}

\item

850

\item

{The client shall produce an editable dialog box containing flashcard

851

{The client shall produce an editable dialog box containing flashcard

text}

852

text}

\item

853

\item

{The user shall make desired changes}

854

{The user shall make desired changes}

\item

855

\item

{The user shall click `Save'}

856

{The user shall click `Save'}

\item

857

\item

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

858

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

it to the server}

859

it to the server}

\item

860

\item

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

861

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

create a new FlashcardMask object and update the appropriate

862

create a new FlashcardMask object and update the appropriate

UserFlashcard object with a reference to it.}

863

UserFlashcard object with a reference to it.}

\item

864

\item

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

865

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

\end{enumerate}

866

\end{enumerate}

867

\begin{enumerate}

868

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

869

\itemsep1pt\parskip0pt\parsep0pt

\item

870

\item

{create a new flashcard for the section}

871

{create a new flashcard for the section}

\item

872

\item

{push it to the feed}

873

{push it to the feed}

\item

874

\item

{add it to the user's deck}

875

{add it to the user's deck}

\item

876

\item

{hide the old card from the user}

877

{hide the old card from the user}

\item

878

\item

{and return the new card to the user}

879

{and return the new card to the user}

\end{enumerate}

880

\end{enumerate}

\end{description}

881

\end{description}

{}

882

{}

883

\newpage

884

\newpage

885

{}

886

{}

887

\subsection{[F3] Pull Flashcard}

888

\subsection{[F3] Pull Flashcard}

\begin{description}

889

\begin{description}

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

890

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

deck from the Live Feed. }

891

deck from the Live Feed. }

892

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

893

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

deck }

894

deck }

\\

895

\\

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

896

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

897

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

898

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

899

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

900

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

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

901

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

\\

902

\\

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

903

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

904

\item[Status]{Not Implemented}

905

\item[Status]{Not Implemented}

906

\item[Pre-conditions]

907

\item[Pre-conditions]

908

\begin{itemize}

909

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

910

\itemsep1pt\parskip0pt\parsep0pt

\item

911

\item

{Flashcard has been created }

912

{Flashcard has been created }

\item

913

\item

{That flashcard is in the Live Feed}

914

{That flashcard is in the Live Feed}

\end{itemize}

915

\end{itemize}

916

\item[Post-conditions]

917

\item[Post-conditions]

918

\begin{itemize}

919

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

920

\itemsep1pt\parskip0pt\parsep0pt

\item

921

\item

{User shall have that flashcard added to their deck}

922

{User shall have that flashcard added to their deck}

\item

923

\item

{User can review this flashcard later}

924

{User can review this flashcard later}

\end{itemize}

925

\end{itemize}

926

\item[Trigger]{User has clicked on the flashcard in the Live Feed.}

927

\item[Trigger]{User has clicked on the flashcard in the Live Feed.}

928

\item[Workflow]

929

\item[Workflow]

930

\begin{enumerate}

931

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

932

\itemsep1pt\parskip0pt\parsep0pt

\item

933

\item

{The User is in the Live Feed.}

934

{The User is in the Live Feed.}

\item

935

\item

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

936

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

the Feed.}

937

the Feed.}

\item

938

\item

{The Client shall make the pulled Flashcard disappear from the Live

939

{The Client shall make the pulled Flashcard disappear from the Live

Feed}

940

Feed}

\item

941

\item

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

942

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

on the sidebar.}

943

on the sidebar.}

\item

944

\item

{The Client shall submit a POST request to

945

{The Client shall submit a POST request to

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

946

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

\item

947

\item

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

948

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

user's deck contains the card.}

949

user's deck contains the card.}

\item

950

\item

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

951

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

if any}

952

if any}

\item

953

\item

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

954

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

rearranging the feed.}

955

rearranging the feed.}

\end{enumerate}

956

\end{enumerate}

\end{description}

957

\end{description}

\newpage

958

\newpage

959

{}

960

{}

961

\subsection{[F4] Flag Inappropriate Cards}

962

\subsection{[F4] Flag Inappropriate Cards}

963

\begin{description}

964

\begin{description}

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

965

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

966

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

967

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

adjusted}

968

adjusted}

\\

969

\\

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

970

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

should not be displayed in the feed}

971

should not be displayed in the feed}

972

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

973

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

974

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

975

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

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

976

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

\\

977

\\

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

978

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

979

\item[Status]{Unimplemented}

980

\item[Status]{Unimplemented}

981

\item[Pre-conditions]

982

\item[Pre-conditions]

983

\begin{itemize}

984

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

985

\itemsep1pt\parskip0pt\parsep0pt

\item

986

\item

{User is enrolled in a class}

987

{User is enrolled in a class}

\end{itemize}

988

\end{itemize}

989

\begin{itemize}

990

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

991

\itemsep1pt\parskip0pt\parsep0pt

\item

992

\item

{Flashcard is created}

993

{Flashcard is created}

\item

994

\item

{Flashcard is viewable in feed}

995

{Flashcard is viewable in feed}

\end{itemize}

996

\end{itemize}

997

\item[Post-conditions]

998

\item[Post-conditions]

999

\begin{itemize}

1000

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1001

\itemsep1pt\parskip0pt\parsep0pt

\item

1002

\item

{Flashcard is hidden from user}

1003

{Flashcard is hidden from user}

\item

1004

\item

{Flashcard internal variable is adjusted}

1005

{Flashcard internal variable is adjusted}

\end{itemize}

1006

\end{itemize}

1007

\item[Trigger]{User clicks flag on a specific flashcard}

1008

\item[Trigger]{User clicks flag on a specific flashcard}

1009

\item[Workflow]

1010

\item[Workflow]

1011

\begin{enumerate}

1012

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1013

\itemsep1pt\parskip0pt\parsep0pt

\item

1014

\item

{The User is at a page of their classes.}

1015

{The User is at a page of their classes.}

\item

1016

\item

{The User selects one of their classes to enter the Live Feed.}

1017

{The User selects one of their classes to enter the Live Feed.}

\item

1018

\item

{The User is on the Live Feed for his/her class.}

1019

{The User is on the Live Feed for his/her class.}

\item

1020

\item

{The User shall identify an inappropriate card and flag the card.}

1021

{The User shall identify an inappropriate card and flag the card.}

\item

1022

\item

{The User clicks the ``Flag as Inappropriate'' button on the flashcard

1023

{The User clicks the ``Flag as Inappropriate'' button on the flashcard

that he/she wants to report}

1024

that he/she wants to report}

\item

1025

\item

{The Client shall hide the card from the user}

1026

{The Client shall hide the card from the user}

\item

1027

\item

{The server shall create a FlashcardReport object}

1028

{The server shall create a FlashcardReport object}

\end{enumerate}

1029

\end{enumerate}

\end{description}

1030

\end{description}

{}

1031

{}

1032

{}

1033

{}

1034

\newpage

1035

\newpage

1036

{}

1037

{}

1038

\subsection{[F5] Filter Flashcards}

1039

\subsection{[F5] Filter Flashcards}

1040

\begin{description}

1041

\begin{description}

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

1042

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

1043

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

1044

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

options}

1045

options}

1046

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

1047

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

for}

1048

for}

1049

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

1050

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

1051

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

1052

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

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

1053

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

Flashcard}

1054

Flashcard}

\\

1055

\\

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

1056

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

1057

\item[Status]{Not}{}{Implemented }

1058

\item[Status]{Not}{}{Implemented }

1059

\item[Pre-conditions]

1060

\item[Pre-conditions]

1061

\begin{itemize}

1062

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1063

\itemsep1pt\parskip0pt\parsep0pt

\item

1064

\item

{User has registered for the course }

1065

{User has registered for the course }

\item

1066

\item

{Flashcards exist in the course}

1067

{Flashcards exist in the course}

\end{itemize}

1068

\end{itemize}

1069

\item[Post-conditions]{}

1070

\item[Post-conditions]{}

1071

\begin{itemize}

1072

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1073

\itemsep1pt\parskip0pt\parsep0pt

\item

1074

\item

{User only sees specific flashcards}

1075

{User only sees specific flashcards}

\end{itemize}

1076

\end{itemize}

1077

\item[Trigger]{User has selected advanced options from menu}

1078

\item[Trigger]{User has selected advanced options from menu}

1079

\item[Workflow]

1080

\item[Workflow]

1081

\begin{enumerate}

1082

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1083

\itemsep1pt\parskip0pt\parsep0pt

\item

1084

\item

{The User chooses one of their classes.}

1085

{The User chooses one of their classes.}

\item

1086

\item

{The User presses the class they want to view.}

1087

{The User presses the class they want to view.}

\item

1088

\item

{The Client displays the Live Feed.}

1089

{The Client displays the Live Feed.}

\item

1090

\item

{The User is at the Live Feed.}

1091

{The User is at the Live Feed.}

\item

1092

\item

{The User wants to filter the cards on the Live Feed.}

1093

{The User wants to filter the cards on the Live Feed.}

\item

1094

\item

{The User shall select what filter option they want from a drop down

1095

{The User shall select what filter option they want from a drop down

menu.}

1096

menu.}

\item

1097

\item

{The Client shall display only relevant flashcards.}

1098

{The Client shall display only relevant flashcards.}

\end{enumerate}

1099

\end{enumerate}

\end{description}

1100

\end{description}

{}

1101

{}

1102

\newpage

1103

\newpage

1104

{}

1105

{}

1106

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

1107

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

1108

\begin{description}

1109

\begin{description}

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

1110

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

flashcard in his deck. }

1111

flashcard in his deck. }

1112

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

1113

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

System that they are keywords. }

1114

System that they are keywords. }

\\

1115

\\

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

1116

\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

1117

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

User guess what they are.}

1118

User guess what they are.}

1119

{Primary Actor: }{User (student)}

1120

{Primary Actor: }{User (student)}

1121

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

1122

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

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

1123

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

\\

1124

\\

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

1125

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

1126

\item[Status]{Not implemented.}

1127

\item[Status]{Not implemented.}

1128

\item[Pre-conditions]

1129

\item[Pre-conditions]

1130

\begin{itemize}

1131

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1132

\itemsep1pt\parskip0pt\parsep0pt

\item

1133

\item

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

1134

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

deck.}

1135

deck.}

\item

1136

\item

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

1137

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

\end{itemize}

1138

\end{itemize}

1139

{Post-conditions: }

1140

{Post-conditions: }

1141

\begin{itemize}

1142

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1143

\itemsep1pt\parskip0pt\parsep0pt

\item

1144

\item

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

1145

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

\item

1146

\item

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

1147

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

1148

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

\end{itemize}

1149

\end{itemize}

1150

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

1151

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

1152

\item[Workflow]

1153

\item[Workflow]

1154

\begin{enumerate}

1155

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1156

\itemsep1pt\parskip0pt\parsep0pt

\item

1157

\item

{The Client shall a show deck to user}

1158

{The Client shall a show deck to user}

\item

1159

\item

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

1160

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

blank out words from}

1161

blank out words from}

\item

1162

\item

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

1163

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

\item

1164

\item

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

1165

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

\item

1166

\item

{The client shall specify a character range as blank}

1167

{The client shall specify a character range as blank}

\item

1168

\item

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

1169

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

that flashcard. }

1170

that flashcard. }

\item

1171

\item

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

1172

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

changes}

1173

changes}

\item

1174

\item

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

1175

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

Flashcard Mask to review}

1176

Flashcard Mask to review}

\item

1177

\item

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

1178

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

the User}

1179

the User}

\end{enumerate}

1180

\end{enumerate}

1181

{Alternative Workflows:}

1182

{Alternative Workflows:}

1183

\begin{enumerate}

1184

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1185

\itemsep1pt\parskip0pt\parsep0pt

\item

1186

\item

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

1187

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

Flashcard''}

1188

Flashcard''}

\item

1189

\item

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

1190

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

\item

1191

\item

{The User shall fill in the information}

1192

{The User shall fill in the information}

\item

1193

\item

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

1194

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

\item

1195

\item

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

1196

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

Flashcard Mask to review}

1197

Flashcard Mask to review}

\item

1198

\item

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

1199

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

the User}

1200

the User}

\end{enumerate}

1201

\end{enumerate}

\end{description}

1202

\end{description}

{}

1203

{}

1204

\newpage

1205

\newpage

1206

{}

1207

{}

1208

\subsection{[F7] Fix Flashcard}

1209

\subsection{[F7] Fix Flashcard}

1210

\begin{description}

1211

\begin{description}

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

1212

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

1213

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

1214

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

1215

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

alteration will be shown to all users of that flashcard}

1216

alteration will be shown to all users of that flashcard}

\\

1217

\\

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

1218

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

than it did originally.}

1219

than it did originally.}

1220

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

1221

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

1222

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

1223

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

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

1224

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

\\

1225

\\

\item[Priority Level]{Must}

1226

\item[Priority Level]{Must}

1227

\item[Status]{Not Implemented}

1228

\item[Status]{Not Implemented}

1229

\item[Pre-conditions]

1230

\item[Pre-conditions]

1231

\begin{itemize}

1232

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1233

\itemsep1pt\parskip0pt\parsep0pt

\item

1234

\item

{User has created the flashcard}

1235

{User has created the flashcard}

\end{itemize}

1236

\end{itemize}

1237

\item[Post-conditions]{}

1238

\item[Post-conditions]{}

1239

\begin{itemize}

1240

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1241

\itemsep1pt\parskip0pt\parsep0pt

\item

1242

\item

{The user shall see their alteration for that flashcard}

1243

{The user shall see their alteration for that flashcard}

\item

1244

\item

{Other users will be notified of the alteration}

1245

{Other users will be notified of the alteration}

\end{itemize}

1246

\end{itemize}

1247

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

1248

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

``Edit''}

1249

``Edit''}

1250

\item[Workflow]

1251

\item[Workflow]

1252

\begin{enumerate}

1253

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1254

\itemsep1pt\parskip0pt\parsep0pt

\item

1255

\item

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

1256

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

\item

1257

\item

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

1258

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

\item

1259

\item

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

1260

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

\item

1261

\item

{The Flashcard will display editable fields/areas.}

1262

{The Flashcard will display editable fields/areas.}

\item

1263

\item

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

1264

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

\item

1265

\item

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

1266

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

\item

1267

\item

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

1268

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

\item

1269

\item

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

1270

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

\item

1271

\item

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

1272

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

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

1273

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

changes.}

1274

changes.}

\end{enumerate}

1275

\end{enumerate}

\end{description}

1276

\end{description}

{}

1277

{}

1278

{}

1279

{}

1280

{}

1281

{}

1282

\newpage

1283

\newpage

1284

{}

1285

{}

1286

\subsection{[F8] Hide cards from feed}

1287

\subsection{[F8] Hide cards from feed}

1288

\begin{description}

1289

\begin{description}

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

1290

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

1291

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

1292

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

\\

1293

\\

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

1294

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

reduce screen clutter}

1295

reduce screen clutter}

1296

{Primary Actor: }{User (Student)}

1297

{Primary Actor: }{User (Student)}

1298

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

1299

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

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

1300

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

\\

1301

\\

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

1302

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

1303

{Status:}{Not implemented}

1304

{Status:}{Not implemented}

1305

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

1306

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

1307

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

1308

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

1309

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

1310

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

1311

\item[Workflow]

1312

\item[Workflow]

1313

\begin{enumerate}

1314

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1315

\itemsep1pt\parskip0pt\parsep0pt

\item

1316

\item

{The User chooses a class from the dashboard.}

1317

{The User chooses a class from the dashboard.}

\item

1318

\item

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

1319

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

\item

1320

\item

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

1321

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

\item

1322

\item

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

1323

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

hidden.}

1324

hidden.}

\item

1325

\item

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

1326

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

only that User.}

1327

only that User.}

\end{enumerate}

1328

\end{enumerate}

1329

\end{description}

1330

\end{description}

1331

\newpage

1332

\newpage

1333

{}

1334

{}

1335

\subsection{[F9] View a Feed}

1336

\subsection{[F9] View a Feed}

1337

\begin{description}

1338

\begin{description}

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

1339

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

classes}

1340

classes}

1341

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

1342

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

specific classes. }

1343

specific classes. }

\\

1344

\\

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

1345

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

1346

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

1347

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

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

1348

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

\\

1349

\\

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

1350

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

1351

{Status:}{Not implemented}

1352

{Status:}{Not implemented}

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

\item[Workflow]

1360

\item[Workflow]

1361

\begin{enumerate}

1362

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1363

\itemsep1pt\parskip0pt\parsep0pt

\item

1364

\item

{The User logs into their account.}

1365

{The User logs into their account.}

\item

1366

\item

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

1367

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

\item

1368

\item

{The User is at their dashboard.}

1369

{The User is at their dashboard.}

\item

1370

\item

{The Client shows the User's dashboard.}

1371

{The Client shows the User's dashboard.}

\item

1372

\item

{The User selects a class from their dashboard.}

1373

{The User selects a class from their dashboard.}

\item

1374

\item

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

1375

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

\end{enumerate}

1376

\end{enumerate}

1377

\end{description}

1378

\end{description}

\newpage

1379

\newpage

1380

{}

1381

{}

\section{Decks}

1382

\section{Decks}

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

1383

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

1384

\begin{description}

1385

\begin{description}

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

1386

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

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

1387

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

new flashcard.}

1388

new flashcard.}

1389

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

1390

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

\\

1391

\\

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

1392

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

1393

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

1394

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

1395

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

1396

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

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

1397

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

\\

1398

\\

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

1399

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

1400

\item[Status]{In Progress}

1401

\item[Status]{In Progress}

1402

\item[Pre-conditions]

1403

\item[Pre-conditions]

1404

\begin{itemize}

1405

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1406

\itemsep1pt\parskip0pt\parsep0pt

\item

1407

\item

{The user has an account with the application. }

1408

{The user has an account with the application. }

\item

1409

\item

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

1410

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

\end{itemize}

1411

\end{itemize}

1412

\item[Post-conditions]

1413

\item[Post-conditions]

1414

\begin{itemize}

1415

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1416

\itemsep1pt\parskip0pt\parsep0pt

\item

1417

\item

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

1418

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

\item

1419

\item

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

1420

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

\end{itemize}

1421

\end{itemize}

1422

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

1423

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

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

1424

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

1425

\item[Workflow]

1426

\item[Workflow]

1427

\begin{enumerate}

1428

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1429

\itemsep1pt\parskip0pt\parsep0pt

\item

1430

\item

{User is at their dashboard.}

1431

{User is at their dashboard.}

\item

1432

\item

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

1433

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

\item

1434

\item

{Client displays the Live Feed for the class.}

1435

{Client displays the Live Feed for the class.}

\item

1436

\item

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

1437

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

in their Deck.}

1438

in their Deck.}

\item

1439

\item

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

1440

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

\item

1441

\item

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

1442

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

\item

1443

\item

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

1444

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

\item

1445

\item

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

1446

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

\end{enumerate}

1447

\end{enumerate}

1448

{Alternate Workflow:}

1449

{Alternate Workflow:}

1450

\begin{enumerate}

1451

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1452

\itemsep1pt\parskip0pt\parsep0pt

\item

1453

\item

{User is at their dashboard.}

1454

{User is at their dashboard.}

\item

1455

\item

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

1456

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

\item

1457

\item

{Client displays the Live Feed for the class.}

1458

{Client displays the Live Feed for the class.}

\item

1459

\item

{The User adds a Flashcard into the Class.}

1460

{The User adds a Flashcard into the Class.}

\item

1461

\item

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

1462

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

\item

1463

\item

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

1464

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

\item

1465

\item

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

1466

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

\item

1467

\item

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

1468

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

\end{enumerate}

1469

\end{enumerate}

\end{description}

1470

\end{description}

\newpage

1471

\newpage

1472

{}

1473

{}

1474

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

1475

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

1476

\begin{description}

1477

\begin{description}

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

1478

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

1479

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

1480

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

\\

1481

\\

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

1482

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

1483

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

1484

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

1485

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

1486

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

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

1487

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

\\

1488

\\

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

1489

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

1490

\item[Status]{Unimplemented}

1491

\item[Status]{Unimplemented}

1492

\item[Pre-conditions]

1493

\item[Pre-conditions]

1494

\begin{itemize}

1495

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1496

\itemsep1pt\parskip0pt\parsep0pt

\item

1497

\item

{The User has an account with the application}

1498

{The User has an account with the application}

\item

1499

\item

{The User is logged in}

1500

{The User is logged in}

\end{itemize}

1501

\end{itemize}

1502

\item[Post-conditions]

1503

\item[Post-conditions]

1504

\begin{itemize}

1505

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1506

\itemsep1pt\parskip0pt\parsep0pt

\item

1507

\item

{Desired cards are hidden to the user.}

1508

{Desired cards are hidden to the user.}

\end{itemize}

1509

\end{itemize}

1510

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

1511

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

1512

\item[Workflow]

1513

\item[Workflow]

1514

\begin{enumerate}

1515

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1516

\itemsep1pt\parskip0pt\parsep0pt

\item

1517

\item

{The Client shows the user the dashboard.}

1518

{The Client shows the user the dashboard.}

\item

1519

\item

{The User shall select the appropriate class.}

1520

{The User shall select the appropriate class.}

\item

1521

\item

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

1522

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

\item

1523

\item

{The User shall select deck view.}

1524

{The User shall select deck view.}

\item

1525

\item

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

1526

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

\item

1527

\item

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

1528

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

\item

1529

\item

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

1530

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

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

1531

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

\item

1532

\item

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

1533

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

\item

1534

\item

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

1535

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

\item

1536

\item

{The Client updates the User's Deck.}

1537

{The Client updates the User's Deck.}

\end{enumerate}

1538

\end{enumerate}

1539

{}

1540

{}

1541

{Alternate Workflow:}

1542

{Alternate Workflow:}

1543

\begin{enumerate}

1544

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1545

\itemsep1pt\parskip0pt\parsep0pt

\item

1546

\item

{The Client shows the user the dashboard.}

1547

{The Client shows the user the dashboard.}

\item

1548

\item

{The User shall select the appropriate class.}

1549

{The User shall select the appropriate class.}

\item

1550

\item

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

1551

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

\item

1552

\item

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

1553

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

\item

1554

\item

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

1555

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

\item

1556

\item

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

1557

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

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

1558

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

\item

1559

\item

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

1560

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

\item

1561

\item

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

1562

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

\item

1563

\item

{The Client updates the User's Deck.}

1564

{The Client updates the User's Deck.}

\end{enumerate}

1565

\end{enumerate}

\end{description}

1566

\end{description}

1567

\subsection{[-D2-] Shuffling deck}

1568

\subsection{[-D2-] Shuffling deck}

1569

\begin{description}

1570

\begin{description}

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

1571

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

the flashcards}

1572

the flashcards}

1573

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

1574

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

flashcards appear in random order}

1575

flashcards appear in random order}

1576

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

1577

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

1578

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

1579

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

1580

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

1581

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

\\

1582

\\

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

1583

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

1584

\item[Status]{Implemented }

1585

\item[Status]{Implemented }

1586

\item[Pre-conditions]

1587

\item[Pre-conditions]

GITLAB

110swag / docs

Made some changes to A9