110swag / docs

\documentclass[letterpaper]{scrartcl} % or whatever

1

\documentclass[letterpaper]{scrartcl} % or whatever

\usepackage{tgpagella}

2

\usepackage{tgpagella}

\setkomafont{disposition}{\normalfont\bfseries}

3

\setkomafont{disposition}{\normalfont\bfseries}

%\usepackage[markuppercase]{scrpage2}

4

%\usepackage[markuppercase]{scrpage2}

\title{\huge Design Use Cases}

5

\title{\huge Design Use Cases}

\date{\today}

6

\date{\today}

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

7

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

\usepackage[pass]{geometry}

8

\usepackage[pass]{geometry}

\usepackage{hyperref}

9

\usepackage{hyperref}

\usepackage{graphicx}

10

\usepackage{graphicx}

\usepackage{enumitem}

11

\usepackage{enumitem}

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

12

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

\setlistdepth{9}

13

\setlistdepth{9}

14

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

15

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

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

16

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

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

17

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

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

18

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

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

19

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

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

20

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

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

21

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

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

22

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

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

23

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

\renewlist{itemize}{itemize}{9}

24

\renewlist{itemize}{itemize}{9}

\begin{document}

25

\begin{document}

\maketitle

26

\maketitle

\begin{center}

27

\begin{center}

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

28

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

29

\begin{tabular}{l r}

30

\begin{tabular}{l r}

Melody Jeng & System Architect \\

31

Melody Jeng & System Architect \\

Arno Gau & Senior System Analyst \\

32

Arno Gau & Senior System Analyst \\

Rachel Lee & Software Development Lead \\

33

Rachel Lee & Software Development Lead \\

Laura Hawkins & Project Manager \\

34

Laura Hawkins & Project Manager \\

Rohan Rangray & Algorithms Specialist\\

35

Rohan Rangray & Algorithms Specialist\\

Andrew Buss & Database Specialist \\

36

Andrew Buss & Database Specialist \\

Phuong Tran & Quality Assurance Lead \\

37

Phuong Tran & Quality Assurance Lead \\

Chung Kang Wang & Business Analyst\\

38

Chung Kang Wang & Business Analyst\\

Masud Rahman & User Interface Specialist\\

39

Masud Rahman & User Interface Specialist\\

Kevin Mach & User Interface Specialist\\

40

Kevin Mach & User Interface Specialist\\

\end{tabular}

41

\end{tabular}

\end{center}

42

\end{center}

\newpage

43

\newpage

\tableofcontents

44

\tableofcontents

\newpage

45

\newpage

46

\section{Accounts}

47

\section{Accounts}

\subsection{[A1] User Registration}

48

\subsection{[A1] User Registration}

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

49

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

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

50

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

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

51

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

through registering.}

52

through registering.}

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

53

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

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

54

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

the aforementioned account.}

55

the aforementioned account.}

\\

56

\\

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

57

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

application's activities.}

58

application's activities.}

59

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

60

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

61

\item[Dependency Use Cases]{None}

62

\item[Dependency Use Cases]{None}

\\

63

\\

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

64

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

65

\item[Status]{Implemented}

66

\item[Status]{Implemented}

67

\item[Pre-conditions]: None.

68

\item[Pre-conditions]: None.

69

\item[Post-conditions]

70

\item[Post-conditions]

71

\begin{itemize}

72

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

73

\itemsep1pt\parskip0pt\parsep0pt

\item

74

\item

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

75

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

\end{itemize}

76

\end{itemize}

77

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

78

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

79

\item[Workflow]

80

\item[Workflow]

81

\begin{enumerate}

82

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

83

\itemsep1pt\parskip0pt\parsep0pt

\item

84

\item

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

85

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

\item

86

\item

{The User shall click the sign up toggle.}

87

{The User shall click the sign up toggle.}

\item

88

\item

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

89

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

\item

90

\item

{The User shal fill in the form.}

91

{The User shal fill in the form.}

\item

92

\item

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

93

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

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

94

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

error and returns this to the user. }

95

error and returns this to the user. }

\item

96

\item

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

97

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

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

98

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

\item

99

\item

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

100

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

returns an error to the frontend.}

101

returns an error to the frontend.}

\item

102

\item

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

103

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

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

104

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

\item

105

\item

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

106

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

\item

107

\item

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

108

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

\item

109

\item

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

110

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

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

111

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

\item

112

\item

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

113

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

session for the User. }

114

session for the User. }

\item

115

\item

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

116

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

future requests.}

117

future requests.}

\end{enumerate}

118

\end{enumerate}

119

{Verification Workflow:}

120

{Verification Workflow:}

121

\begin{enumerate}

122

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

123

\itemsep1pt\parskip0pt\parsep0pt

\item

124

\item

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

125

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

User clicks the link}

126

User clicks the link}

\item

127

\item

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

128

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

\item

129

\item

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

130

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

an error to the frontend.}

131

an error to the frontend.}

\item

132

\item

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

133

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

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

134

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

\item

135

\item

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

136

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

\end{enumerate}

137

\end{enumerate}

138

\end{description}

139

\end{description}

140

\newpage

141

\newpage

\subsection{[A2] User Login}

142

\subsection{[A2] User Login}

143

\begin{description}

144

\begin{description}

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

145

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

146

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

147

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

password to access their courses and flash cards. The user shall gain

148

password to access their courses and flash cards. The user shall gain

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

149

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

the flash cards they have added to their decks.}

150

the flash cards they have added to their decks.}

\\

151

\\

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

152

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

device, or use the site after logging out.}

153

device, or use the site after logging out.}

154

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

155

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

156

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

157

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

\\

158

\\

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

159

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

160

\item[Status]{Implemented}

161

\item[Status]{Implemented}

162

\item[Pre-conditions]

163

\item[Pre-conditions]

164

\begin{itemize}

165

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

166

\itemsep1pt\parskip0pt\parsep0pt

\item

167

\item

{The User has registered an account.}

168

{The User has registered an account.}

{The User knows their email and password.}

169

{The User knows their email and password.}

\end{itemize}

170

\end{itemize}

171

\item[Post-conditions]

172

\item[Post-conditions]

173

\begin{itemize}

174

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

175

\itemsep1pt\parskip0pt\parsep0pt

\item

176

\item

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

177

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

\end{itemize}

178

\end{itemize}

179

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

180

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

181

\item[Workflow]

182

\item[Workflow]

183

\begin{enumerate}

184

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

185

\itemsep1pt\parskip0pt\parsep0pt

\item

186

\item

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

187

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

\item

188

\item

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

189

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

\item

190

\item

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

191

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

\item

192

\item

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

193

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

\item

194

\item

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

195

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

\item

196

\item

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

197

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

\end{enumerate}

198

\end{enumerate}

\end{description}

199

\end{description}

\newpage

200

\newpage

201

\subsection{[A3] Add a Class}

202

\subsection{[A3] Add a Class}

\begin{description}

203

\begin{description}

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

204

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

flashcards associated with that class.}

205

flashcards associated with that class.}

206

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

207

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

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

208

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

for this class.}

209

for this class.}

\\

210

\\

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

211

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

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

212

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

213

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

214

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

215

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

216

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

Login}

217

Login}

\\

218

\\

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

219

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

220

\item[Status]{Implemented}

221

\item[Status]{Implemented}

222

\item[Pre-conditions]

223

\item[Pre-conditions]

224

\begin{itemize}

225

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

226

\itemsep1pt\parskip0pt\parsep0pt

\item

227

\item

{The User has registered an account.}

228

{The User has registered an account.}

\item

229

\item

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

230

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

\end{itemize}

231

\end{itemize}

232

\item[Post-conditions]

233

\item[Post-conditions]

234

\begin{itemize}

235

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

236

\itemsep1pt\parskip0pt\parsep0pt

\item

237

\item

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

238

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

add them to their deck.}

239

add them to their deck.}

\item

240

\item

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

241

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

in the same class.}

242

in the same class.}

\end{itemize}

243

\end{itemize}

244

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

245

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

246

\item[Workflow]

247

\item[Workflow]

248

\begin{enumerate}

249

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

250

\itemsep1pt\parskip0pt\parsep0pt

\item

251

\item

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

252

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

\item

253

\item

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

254

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

\item

255

\item

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

256

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

\item

257

\item

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

258

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

\item

259

\item

{The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.}

260

{The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.}

\item

261

\item

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

262

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

\item

263

\item

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

264

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

\item

265

\item

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

266

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

\item

267

\item

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

268

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

\item

269

\item

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

270

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

\item

271

\item

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

272

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

\item

273

\item

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

274

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

\item

275

\item

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

276

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

\item

277

\item

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

278

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

279

\end{enumerate}

280

\end{enumerate}

281

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

282

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

\begin{enumerate}

283

\begin{enumerate}

\setcounter{enumi}{3}

284

\setcounter{enumi}{3}

\itemsep1pt\parskip0pt\parsep0pt

285

\itemsep1pt\parskip0pt\parsep0pt

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

286

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

\item

287

\item

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

288

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

\item

289

\item

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

290

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

the course ID that the User typed. }

291

the course ID that the User typed. }

\item

292

\item

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

293

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

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

294

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

\item

295

\item

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

296

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

in function is\_user\_on\_whitelist.}

297

in function is\_user\_on\_whitelist.}

\item

298

\item

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

299

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

\item

300

\item

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

301

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

\end{enumerate}

302

\end{enumerate}

303

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

304

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

\begin{enumerate}

305

\begin{enumerate}

\setcounter{enumi}{7}

306

\setcounter{enumi}{7}

\itemsep1pt\parskip0pt\parsep0pt

307

\itemsep1pt\parskip0pt\parsep0pt

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

308

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

\item

309

\item

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

310

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

\item

311

\item

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

312

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

\end{enumerate}

313

\end{enumerate}

314

\end{description}

315

\end{description}

{}

316

{}

317

\newpage

318

\newpage

319

{}

320

{}

321

\subsection{[A4] Drop a Class}

322

\subsection{[A4] Drop a Class}

323

\begin{description}

324

\begin{description}

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

325

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

registered to}

326

registered to}

327

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

328

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

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

329

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

see the flashcards associated to the class that they dropped }

330

see the flashcards associated to the class that they dropped }

\\

331

\\

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

332

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

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

333

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

listed in their drop down menu.}

334

listed in their drop down menu.}

335

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

336

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

337

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

338

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

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

339

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

\\

340

\\

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

341

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

342

\item[Status]{Implemented }

343

\item[Status]{Implemented }

344

\item[Pre-conditions]

345

\item[Pre-conditions]

346

\begin{itemize}

347

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

348

\itemsep1pt\parskip0pt\parsep0pt

\item

349

\item

{The User has a valid account.}

350

{The User has a valid account.}

\item

351

\item

{The User is logged in.}

352

{The User is logged in.}

\item

353

\item

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

354

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

\item

355

\item

{The User has navigated to the Settings page.}

356

{The User has navigated to the Settings page.}

\end{itemize}

357

\end{itemize}

358

\item[Post-conditions]{}

359

\item[Post-conditions]{}

360

\begin{itemize}

361

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

362

\itemsep1pt\parskip0pt\parsep0pt

\item

363

\item

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

364

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

flashcards}

365

flashcards}

\end{itemize}

366

\end{itemize}

367

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

368

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

369

\item[Workflow]

370

\item[Workflow]

371

\begin{enumerate}

372

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

373

\itemsep1pt\parskip0pt\parsep0pt

\item

374

\item

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

375

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

\item

376

\item

{The frontend shall submit a DELETE request to

377

{The frontend shall submit a DELETE request to

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

378

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

\item

379

\item

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

380

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

\item

381

\item

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

382

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

\item

383

\item

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

384

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

\end{enumerate}

385

\end{enumerate}

\end{description}

386

\end{description}

\newpage

387

\newpage

388

{}

389

{}

390

\subsection{[A5] Password change}

391

\subsection{[A5] Password change}

392

\begin{description}

393

\begin{description}

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

394

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

account in the account settings. }

395

account in the account settings. }

396

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

397

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

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

398

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

\\\\

399

\\\\

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

400

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

401

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

402

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

403

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

404

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

Login}

405

Login}

\\

406

\\

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

407

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

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

408

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

password to the requested new password.}

409

password to the requested new password.}

410

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

411

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

412

\item[Status]{Implemented}

413

\item[Status]{Implemented}

414

\item[Pre-conditions]

415

\item[Pre-conditions]

416

\begin{itemize}

417

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

418

\itemsep1pt\parskip0pt\parsep0pt

\item

419

\item

{The User has registered an account.}

420

{The User has registered an account.}

\item

421

\item

{The User has logged in.}

422

{The User has logged in.}

\item

423

\item

{The User knows their current password.}

424

{The User knows their current password.}

\item

425

\item

{The User has navigated to the Settings page.}

426

{The User has navigated to the Settings page.}

\end{itemize}

427

\end{itemize}

428

\item[Post-conditions]

429

\item[Post-conditions]

430

\begin{itemize}

431

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

432

\itemsep1pt\parskip0pt\parsep0pt

\item

433

\item

{The User's password is changed}

434

{The User's password is changed}

\item

435

\item

{The User can log in with the new password}

436

{The User can log in with the new password}

\end{itemize}

437

\end{itemize}

438

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

439

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

440

\item[Error Handling]

441

\item[Error Handling]

\begin{description}

442

\begin{description}

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

443

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

\item The client shall enforce required fields

444

\item The client shall enforce required fields

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

445

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

\end{itemize}

446

\end{itemize}

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

447

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

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

448

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

\end{itemize}

449

\end{itemize}

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

450

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

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

451

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

\end{itemize}

452

\end{itemize}

\end{description}

453

\end{description}

\item[Workflow]

454

\item[Workflow]

455

\begin{enumerate}

456

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

457

\itemsep1pt\parskip0pt\parsep0pt

\item

458

\item

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

459

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

old password and new password from settings.html}

460

old password and new password from settings.html}

\item

461

\item

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

462

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

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

463

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

\item

464

\item

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

465

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

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

466

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

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

467

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

\item (The )

468

\item (The )

\item

469

\item

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

470

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

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

471

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

\item

472

\item

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

473

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

\end{enumerate}

474

\end{enumerate}

\end{description}

475

\end{description}

{}

476

{}

477

\newpage

478

\newpage

479

{}

480

{}

481

\subsection{[A6] Password reset}

482

\subsection{[A6] Password reset}

483

\begin{description}

484

\begin{description}

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

485

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

being logged in.}

486

being logged in.}

487

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

488

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

they remember.}

489

they remember.}

\\

490

\\

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

491

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

492

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

493

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

494

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

495

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

\\

496

\\

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

497

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

the address is valid, the site sends a password reset link with a random

498

the address is valid, the site sends a password reset link with a random

token to that address. If the address is invalid, the site does not send

499

token to that address. If the address is invalid, the site does not send

a link. For security reasons, we do not reveal to the user whether the

500

a link. For security reasons, we do not reveal to the user whether the

email address was valid, and we expire the link after 24 hours. When a

501

email address was valid, and we expire the link after 24 hours. When a

user visits the link emailed to them, they are able to specify a new

502

user visits the link emailed to them, they are able to specify a new

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

503

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

if the token is correct. }

504

if the token is correct. }

505

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

506

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

507

\item[Status]{Implemented}

508

\item[Status]{Implemented}

509

\item[Pre-conditions]

510

\item[Pre-conditions]

511

\begin{itemize}

512

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

513

\itemsep1pt\parskip0pt\parsep0pt

\item

514

\item

{The User has created an account before.}

515

{The User has created an account before.}

\item

516

\item

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

517

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

\item

518

\item

{The User can log into their email account.}

519

{The User can log into their email account.}

\end{itemize}

520

\end{itemize}

521

\item[Post-conditions]

522

\item[Post-conditions]

523

\begin{itemize}

524

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

525

\itemsep1pt\parskip0pt\parsep0pt

\item

526

\item

{The User's password is changed.}

527

{The User's password is changed.}

\item

528

\item

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

529

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

\end{itemize}

530

\end{itemize}

531

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

532

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

\item[Workflow]

533

\item[Workflow]

534

\begin{enumerate}

535

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

536

\itemsep1pt\parskip0pt\parsep0pt

\item

537

\item

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

538

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

\item

539

\item

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

540

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

\item

541

\item

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

542

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

\item

543

\item

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

544

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

\item

545

\item

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

546

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

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

547

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

\item

548

\item

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

549

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

request\_password\_reset.}

550

request\_password\_reset.}

\item

551

\item

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

552

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

\item

553

\item

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

554

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

\item

555

\item

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

556

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

\item

557

\item

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

558

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

the new password in ResetPasswordController.js.}

559

the new password in ResetPasswordController.js.}

\item

560

\item

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

561

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

\item

562

\item

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

563

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

\item

564

\item

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

565

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

\item

566

\item

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

567

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

\end{enumerate}

568

\end{enumerate}

\end{description}

569

\end{description}

\newpage

570

\newpage

571

{}

572

{}

573

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

574

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

575

\begin{description}

576

\begin{description}

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

577

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

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

578

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

are actually in the class.}

579

are actually in the class.}

580

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

581

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

users who are whitelisted may enroll in the class.}

582

users who are whitelisted may enroll in the class.}

\\

583

\\

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

584

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

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

585

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

else.}

586

else.}

587

{Primary Actor: }{User (instructor)}

588

{Primary Actor: }{User (instructor)}

589

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

590

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

Login}

591

Login}

\\

592

\\

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

593

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

594

\item[Status]{Implemented}

595

\item[Status]{Implemented}

596

\item[Pre-conditions]

597

\item[Pre-conditions]

598

\begin{itemize}

599

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

600

\itemsep1pt\parskip0pt\parsep0pt

\item

601

\item

{User has valid instructor's account}

602

{User has valid instructor's account}

\end{itemize}

603

\end{itemize}

604

\item[Post-conditions]

605

\item[Post-conditions]

606

\begin{itemize}

607

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

608

\itemsep1pt\parskip0pt\parsep0pt

\item

609

\item

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

610

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

\end{itemize}

611

\end{itemize}

612

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

613

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

can add his class on our application.}

614

can add his class on our application.}

615

\item[Workflow]

616

\item[Workflow]

617

\begin{enumerate}

618

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

619

\itemsep1pt\parskip0pt\parsep0pt

\item

620

\item

{The instructor emails the administrators from his UCSD email address

621

{The instructor emails the administrators from his UCSD email address

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

622

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

emails of the students that are to be whitelisted.}

623

emails of the students that are to be whitelisted.}

\item

624

\item

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

625

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

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

626

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

frontend here) to the server.}

627

frontend here) to the server.}

\item

628

\item

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

629

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

attaching it to the section taught by the instructor.}

630

attaching it to the section taught by the instructor.}

\item

631

\item

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

632

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

in the whitelist to the class. }

633

in the whitelist to the class. }

\end{enumerate}

634

\end{enumerate}

\end{description}

635

\end{description}

\newpage

636

\newpage

637

\subsection{[A8] User Logout}

638

\subsection{[A8] User Logout}

639

\begin{description}

640

\begin{description}

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

641

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

the site.}

642

the site.}

643

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

644

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

accessible after logging out. }

645

accessible after logging out. }

\\

646

\\

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

647

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

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

648

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

account.}

649

account.}

650

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

651

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

652

\item[Dependency Use Cases] None

653

\item[Dependency Use Cases] None

\\

654

\\

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

655

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

656

\item[Status]{Implemented}

657

\item[Status]{Implemented}

658

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

659

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

660

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

661

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

662

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

663

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

664

\item[Workflow]

665

\item[Workflow]

666

\begin{enumerate}

667

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

668

\itemsep1pt\parskip0pt\parsep0pt

\item

669

\item

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

670

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

\item

671

\item

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

672

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

\item

673

\item

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

674

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

\end{enumerate}

675

\end{enumerate}

676

\end{description}

677

\end{description}

678

\newpage

679

\newpage

680

681

682

\subsection{[A9] Contact Admin}

683

\subsection{[A9] Contact Admin}

684

\begin{description}

685

\begin{description}

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

686

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

687

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

688

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

admin shall receive the message.}

689

admin shall receive the message.}

690

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

691

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

692

\item[Primary Actor]{User}

693

\item[Primary Actor]{User}

694

\item[Dependency Use Cases]{None}

695

\item[Dependency Use Cases]{None}

\\

696

\\

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

697

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

698

\item[Status]{Implemented}

699

\item[Status]{Implemented}

700

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

701

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

702

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

703

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

704

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

705

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

bug reports, questions, or praise. }

706

bug reports, questions, or praise. }

707

\item[Workflow]

708

\item[Workflow]

709

\begin{enumerate}

710

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

711

\itemsep1pt\parskip0pt\parsep0pt

\item

712

\item

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

713

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

\item

714

\item

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

715

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

\item

716

\item

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

717

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

\item

718

\item

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

719

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

\item

720

\item

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

721

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

\item

722

\item

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

723

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

\end{enumerate}

724

\end{enumerate}

\end{description}

725

\end{description}

\newpage

726

\newpage

727

{}

728

{}

\section{Flashcards}

729

\section{Flashcards}

\subsection{[F1] Push Flashcard}

730

\subsection{[F1] Push Flashcard}

731

\begin{description}

732

\begin{description}

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

733

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

input. }

734

input. }

735

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

736

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

deck and the Live Feed. }

737

deck and the Live Feed. }

\\

738

\\

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

739

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

flashcard will be shared with others. }

740

flashcard will be shared with others. }

741

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

742

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

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

743

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

\\

744

\\

\item[Pre-conditions]

745

\item[Pre-conditions]

746

\begin{itemize}

747

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

748

\itemsep1pt\parskip0pt\parsep0pt

\item

749

\item

{The User has an account.}

750

{The User has an account.}

\item

751

\item

{The User has added at least one class.}

752

{The User has added at least one class.}

\item

753

\item

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

754

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

\end{itemize}

755

\end{itemize}

756

\item[Post-conditions]

757

\item[Post-conditions]

758

\begin{itemize}

759

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

760

\itemsep1pt\parskip0pt\parsep0pt

\item

761

\item

{The User has flashcard added to their deck.}

762

{The User has flashcard added to their deck.}

\item

763

\item

{The Flashcard is shown in the Live Feed.}

764

{The Flashcard is shown in the Live Feed.}

\item

765

\item

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

766

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

\end{itemize}

767

\end{itemize}

768

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

769

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

770

\item[Workflow]

771

\item[Workflow]

772

\begin{enumerate}

773

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

774

\itemsep1pt\parskip0pt\parsep0pt

\item

775

\item

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

776

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

\item

777

\item

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

778

{The User shall click on the '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] {The User wants to change a card to show different information.}

flashcard}

837

838

\item[Workflow]

839

837

\item[Workflow]

840

838

\begin{enumerate}

841

839

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

842

840

\itemsep1pt\parskip0pt\parsep0pt

841

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

\item

843

842

\item

{The user shall view their deck}

844

843

{The frontend shall produce an editable dialog box containing flashcard

844

text }

\item

845

\item

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

846

chronological creation order}

847

\item

848

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

849

\item

850

{The client shall produce an editable dialog box containing flashcard

851

text}

852

\item

853

{The user shall make desired changes}

854

846

{The user shall make desired changes}

\item

855

847

\item

{The user shall click `Save'}

856

848

{The user shall click `Save'}

\item

857

849

\item

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

858

850

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

it to the server}

859

851

it to the server}

\item

860

852

\item

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

861

853

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

create a new FlashcardMask object and update the appropriate

862

854

create a new FlashcardMask object and update the appropriate

UserFlashcard object with a reference to it.}

863

855

UserFlashcard object with a reference to it.}

\item

864

856

\item

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

865

857

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

\end{enumerate}

866

858

\end{enumerate}

867

859

\begin{enumerate}

868

860

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

869

861

\itemsep1pt\parskip0pt\parsep0pt

\item

870

862

\item

{create a new flashcard for the section}

871

863

{create a new flashcard for the section}

\item

872

864

\item

{push it to the feed}

873

865

{push it to the feed}

\item

874

866

\item

{add it to the user's deck}

875

867

{add it to the user's deck}

\item

876

868

\item

{hide the old card from the user}

877

869

{hide the old card from the user}

\item

878

870

\item

{and return the new card to the user}

879

871

{and return the new card to the user}

\end{enumerate}

880

872

\end{enumerate}

\end{description}

881

873

\end{description}

{}

882

874

{}

883

875

\newpage

884

876

\newpage

885

877

{}

886

878

{}

887

879

\subsection{[F3] Pull Flashcard}

888

880

\subsection{[F3] Pull Flashcard}

\begin{description}

889

881

\begin{description}

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

890

882

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

deck from the Live Feed. }

891

883

deck from the Live Feed. }

892

884

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

893

885

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

deck }

894

886

deck }

\\

895

887

\\

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

896

888

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

897

889

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

898

890

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

899

891

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

900

892

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

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

901

893

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

\\

902

894

\\

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

903

895

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

904

896

\item[Status]{Not Implemented}

905

897

\item[Status]{Implemented}

906

898

\item[Pre-conditions]

907

899

\item[Pre-conditions]

908

900

\begin{itemize}

909

901

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

910

902

\itemsep1pt\parskip0pt\parsep0pt

\item

911

903

\item

{Flashcard has been created }

912

904

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

\item

913

905

\item

{That flashcard is in the Live Feed}

914

906

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

\end{itemize}

915

907

\end{itemize}

916

908

\item[Post-conditions]

917

909

\item[Post-conditions]

918

910

\begin{itemize}

919

911

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

920

912

\itemsep1pt\parskip0pt\parsep0pt

\item

921

913

\item

{User shall have that flashcard added to their deck}

922

914

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

\item

923

915

\item

{User can review this flashcard later}

924

916

{User can review this flashcard later.}

\end{itemize}

925

917

\end{itemize}

926

918

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

927

919

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

928

920

\item[Workflow]

929

921

\item[Workflow]

930

922

\begin{enumerate}

931

923

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

932

924

\itemsep1pt\parskip0pt\parsep0pt

\item

933

925

\item

{The User is in the Live Feed.}

934

\item

935

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

936

926

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

the Feed.}

937

927

the Feed.}

\item

938

928

\item

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

939

929

{The frontend shall }

Feed}

940

\item

941

930

\item

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

942

931

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

on the sidebar.}

943

932

on the sidebar.}

\item

944

933

\item

{The Client shall submit a POST request to

945

934

{The Client shall submit a POST request to

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

946

935

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

\item

947

936

\item

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

948

937

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

user's deck contains the card.}

949

938

user's deck contains the card.}

\item

950

939

\item

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

951

940

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

if any}

952

941

if any}

\item

953

942

\item

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

954

943

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

rearranging the feed.}

955

944

rearranging the feed.}

\end{enumerate}

956

945

\end{enumerate}

\end{description}

957

946

\end{description}

\newpage

958

947

\newpage

959

948

{}

960

949

{}

961

950

\subsection{[F4] Flag Inappropriate Cards}

962

951

\subsection{[F4] Flag Inappropriate Cards}

963

952

\begin{description}

964

953

\begin{description}

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

965

954

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

966

955

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

967

956

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

adjusted}

968

957

adjusted.}

\\

969

958

\\

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

970

959

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

should not be displayed in the feed}

971

960

should not be displayed in the feed.}

972

961

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

973

962

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

974

963

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

975

964

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

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

976

965

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

\\

977

966

\\

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

978

967

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

979

968

\item[Status]{Unimplemented}

980

969

\item[Status]{Implemented}

981

970

\item[Pre-conditions]

982

971

\item[Pre-conditions]

983

972

\begin{itemize}

984

973

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

985

974

\itemsep1pt\parskip0pt\parsep0pt

\item

986

975

\item

{User is enrolled in a class}

987

976

{User is enrolled in a class}

\end{itemize}

988

977

\end{itemize}

989

978

\begin{itemize}

990

979

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

991

980

\itemsep1pt\parskip0pt\parsep0pt

\item

992

981

\item

{Flashcard is created}

993

982

{Flashcard is created.}

\item

994

983

\item

{Flashcard is viewable in feed}

995

984

{Flashcard is viewable in feed.}

985

\item

986

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

\end{itemize}

996

987

\end{itemize}

997

988

\item[Post-conditions]

998

989

\item[Post-conditions]

999

990

\begin{itemize}

1000

991

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1001

992

\itemsep1pt\parskip0pt\parsep0pt

\item

1002

993

\item

{Flashcard is hidden from user}

1003

994

{Flashcard is hidden from user.}

\item

1004

995

\item

{Flashcard internal variable is adjusted}

1005

996

{Flashcard internal variable is adjusted.}

\end{itemize}

1006

997

\end{itemize}

1007

998

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

1008

999

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

1009

1000

\item[Workflow]

1010

1001

\item[Workflow]

1011

1002

\begin{enumerate}

1012

1003

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1013

1004

\itemsep1pt\parskip0pt\parsep0pt

1005

\item {

1006

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

\item

1014

1007

\item

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

1015

1008

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

\item

1016

1009

\item

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

1017

1010

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

\item

1018

1011

\item

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

1019

1012

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

\item

1020

1013

\item

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

1021

1014

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

\item

1022

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

1023

that he/she wants to report}

1024

\item

1025

{The Client shall hide the card from the user}

1026

\item

1027

{The server shall create a FlashcardReport object}

1028

\end{enumerate}

1029

1015

\end{enumerate}

\end{description}

1030

1016

\end{description}

{}

1031

1017

{}

1032

1018

{}

1033

1019

{}

1034

1020

\newpage

1035

1021

\newpage

1036

1022

{}

1037

1023

{}

1038

1024

\subsection{[F5] Filter Flashcards}

1039

1025

\subsection{[F5] Filter Flashcards - Deferred}

1040

1026

\begin{description}

1041

1027

\begin{description}

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

1042

1028

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

1043

1029

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

1044

1030

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

options}

1045

1031

options.}

1046

1032

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

1047

1033

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

for}

1048

1034

for.}

1049

1035

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

1050

1036

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

1051

1037

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

1052

1038

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

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

1053

1039

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

Flashcard}

1054

1040

Flashcard}

\\

1055

1041

\\

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

1056

1042

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

1057

1043

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

1058

1044

\item[Status]{Not Implemented }

1059

1045

\item[Pre-conditions]

1060

1046

\item[Pre-conditions]

1061

1047

\begin{itemize}

1062

1048

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1063

1049

\itemsep1pt\parskip0pt\parsep0pt

\item

1064

1050

\item

{User has registered for the course }

1065

1051

{User has added the class.}

\item

1066

1052

\item

{Flashcards exist in the course}

1067

1053

{Flashcards exist in the course.}

1054

\item

1055

{The User has navigated to the study page.}

\end{itemize}

1068

1056

\end{itemize}

1069

1057

\item[Post-conditions]{}

1070

1058

\item[Post-conditions]{}

1071

1059

\begin{itemize}

1072

1060

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1073

1061

\itemsep1pt\parskip0pt\parsep0pt

\item

1074

1062

\item

{User only sees specific flashcards}

1075

1063

{User only sees specific flashcards}

\end{itemize}

1076

1064

\end{itemize}

1077

1065

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

1078

1066

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

1079

1067

\item[Workflow]

1080

1068

\item[Workflow]

1081

1069

\begin{enumerate}

1082

1070

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1083

1071

\itemsep1pt\parskip0pt\parsep0pt

\item

1084

1072

\item

{The User chooses one of their classes.}

1085

1073

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

\item

1086

1074

\item

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

1087

1075

{The User fills in the date fields.}

\item

1088

1076

\item

{The Client displays the Live Feed.}

1089

1077

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

\item

1090

1078

\item

{The User is at the Live Feed.}

1091

1079

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

\item

1092

1080

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

1093

\item

1094

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

1095

menu.}

1096

\item

1097

{The Client shall display only relevant flashcards.}

1098

\end{enumerate}

1099

1081

\end{enumerate}

\end{description}

1100

1082

\end{description}

{}

1101

1083

{}

1102

1084

\newpage

1103

1085

\newpage

1104

1086

{}

1105

1087

{}

1106

1088

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

1107

1089

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

1108

1090

\begin{description}

1109

1091

\begin{description}

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

1110

1092

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

flashcard in his deck. }

1111

1093

flashcard in his deck. }

1112

1094

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

1113

1095

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

System that they are keywords. }

1114

1096

System that they are keywords. }

\\

1115

1097

\\

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

1116

1098

\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

1099

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

User guess what they are.}

1118

1100

User guess what they are.}

1119

1101

{Primary Actor: }{User (student)}

1120

1102

{Primary Actor: }{User (student)}

1121

1103

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

1122

1104

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

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

1123

1105

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

\\

1124

1106

\\

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

1125

1107

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

1126

1108

\item[Status]{Not implemented.}

1127

1109

\item[Status]{Not implemented.}

1128

1110

\item[Pre-conditions]

1129

1111

\item[Pre-conditions]

1130

1112

\begin{itemize}

1131

1113

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1132

1114

\itemsep1pt\parskip0pt\parsep0pt

\item

1133

1115

\item

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

1134

1116

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

deck.}

1135

1117

deck.}

\item

1136

1118

\item

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

1137

1119

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

\end{itemize}

1138

1120

\end{itemize}

1139

1121

{Post-conditions: }

1140

1122

{Post-conditions: }

1141

1123

\begin{itemize}

1142

1124

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1143

1125

\itemsep1pt\parskip0pt\parsep0pt

\item

1144

1126

\item

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

1145

1127

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

\item

1146

1128

\item

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

1147

1129

{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

1130

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

\end{itemize}

1149

1131

\end{itemize}

1150

1132

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

1151

1133

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

1152

1134

\item[Workflow]

1153

1135

\item[Workflow]

1154

1136

\begin{enumerate}

1155

1137

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1156

1138

\itemsep1pt\parskip0pt\parsep0pt

\item

1157

1139

\item

{The Client shall a show deck to user}

1158

1140

{The Client shall a show deck to user}

\item

1159

1141

\item

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

1160

1142

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

blank out words from}

1161

1143

blank out words from}

\item

1162

1144

\item

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

1163

1145

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

\item

1164

1146

\item

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

1165

1147

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

\item

1166

1148

\item

{The client shall specify a character range as blank}

1167

1149

{The client shall specify a character range as blank}

\item

1168

1150

\item

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

1169

1151

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

that flashcard. }

1170

1152

that flashcard. }

\item

1171

1153

\item

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

1172

1154

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

changes}

1173

1155

changes}

\item

1174

1156

\item

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

1175

1157

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

Flashcard Mask to review}

1176

1158

Flashcard Mask to review}

\item

1177

1159

\item

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

1178

1160

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

the User}

1179

1161

the User}

\end{enumerate}

1180

1162

\end{enumerate}

1181

1163

{Alternative Workflows:}

1182

1164

{Alternative Workflows:}

1183

1165

\begin{enumerate}

1184

1166

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1185

1167

\itemsep1pt\parskip0pt\parsep0pt

\item

1186

1168

\item

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

1187

1169

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

Flashcard''}

1188

1170

Flashcard''}

\item

1189

1171

\item

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

1190

1172

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

\item

1191

1173

\item

{The User shall fill in the information}

1192

1174

{The User shall fill in the information}

\item

1193

1175

\item

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

1194

1176

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

\item

1195

1177

\item

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

1196

1178

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

Flashcard Mask to review}

1197

1179

Flashcard Mask to review}

\item

1198

1180

\item

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

1199

1181

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

the User}

1200

1182

the User}

\end{enumerate}

1201

1183

\end{enumerate}

\end{description}

1202

1184

\end{description}

{}

1203

1185

{}

1204

1186

\newpage

1205

1187

\newpage

1206

1188

{}

1207

1189

{}

1208

1190

\subsection{[F7] Fix Flashcard}

1209

1191

\subsection{[F7] Fix Flashcard}

1210

1192

\begin{description}

1211

1193

\begin{description}

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

1212

1194

\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

1195

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

1214

1196

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

1215

1197

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

alteration will be shown to all users of that flashcard}

1216

1198

alteration will be shown to all users of that flashcard}

\\

1217

1199

\\

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

1218

1200

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

than it did originally.}

1219

1201

than it did originally.}

1220

1202

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

1221

1203

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

1222

1204

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

1223

1205

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

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

1224

1206

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

\\

1225

1207

\\

\item[Priority Level]{Must}

1226

1208

\item[Priority Level]{Must}

1227

1209

\item[Status]{Not Implemented}

1228

1210

\item[Status]{Not Implemented}

1229

1211

\item[Pre-conditions]

1230

1212

\item[Pre-conditions]

1231

1213

\begin{itemize}

1232

1214

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1233

1215

\itemsep1pt\parskip0pt\parsep0pt

\item

1234

1216

\item

{User has created the flashcard}

1235

1217

{User has created the flashcard}

\end{itemize}

1236

1218

\end{itemize}

1237

1219

\item[Post-conditions]{}

1238

1220

\item[Post-conditions]{}

1239

1221

\begin{itemize}

1240

1222

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1241

1223

\itemsep1pt\parskip0pt\parsep0pt

\item

1242

1224

\item

{The user shall see their alteration for that flashcard}

1243

1225

{The user shall see their alteration for that flashcard}

\item

1244

1226

\item

{Other users will be notified of the alteration}

1245

1227

{Other users will be notified of the alteration}

\end{itemize}

1246

1228

\end{itemize}

1247

1229

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

1248

1230

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

``Edit''}

1249

1231

``Edit''}

1250

1232

\item[Workflow]

1251

1233

\item[Workflow]

1252

1234

\begin{enumerate}

1253

1235

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1254

1236

\itemsep1pt\parskip0pt\parsep0pt

\item

1255

1237

\item

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

1256

1238

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

\item

1257

1239

\item

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

1258

1240

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

\item

1259

1241

\item

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

1260

1242

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

\item

1261

1243

\item

{The Flashcard will display editable fields/areas.}

1262

1244

{The Flashcard will display editable fields/areas.}

\item

1263

1245

\item

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

1264

1246

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

\item

1265

1247

\item

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

1266

1248

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

\item

1267

1249

\item

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

1268

1250

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

\item

1269

1251

\item

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

1270

1252

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

\item

1271

1253

\item

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

1272

1254

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

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

1273

1255

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

changes.}

1274

1256

changes.}

\end{enumerate}

1275

1257

\end{enumerate}

\end{description}

1276

1258

\end{description}

{}

1277

1259

{}

1278

1260

{}

1279

1261

{}

1280

1262

{}

1281

1263

{}

1282

1264

\newpage

1283

1265

\newpage

1284

1266

{}

1285

1267

{}

1286

1268

\subsection{[F8] Hide cards from feed}

1287

1269

\subsection{[F8] Hide cards from feed}

1288

1270

\begin{description}

1289

1271

\begin{description}

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

1290

1272

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

1291

1273

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

1292

1274

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

\\

1293

1275

\\

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

1294

1276

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

reduce screen clutter}

1295

1277

reduce screen clutter}

1296

1278

{Primary Actor: }{User (Student)}

1297

1279

{Primary Actor: }{User (Student)}

1298

1280

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

1299

1281

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

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

1300

1282

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

\\

1301

1283

\\

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

1302

1284

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

1303

1285

{Status:}{Not implemented}

1304

1286

{Status:}{Not implemented}

1305

1287

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

1306

1288

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

1307

1289

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

1308

1290

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

1309

1291

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

1310

1292

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

1311

1293

\item[Workflow]

1312

1294

\item[Workflow]

1313

1295

\begin{enumerate}

1314

1296

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1315

1297

\itemsep1pt\parskip0pt\parsep0pt

\item

1316

1298

\item

{The User chooses a class from the dashboard.}

1317

1299

{The User chooses a class from the dashboard.}

\item

1318

1300

\item

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

1319

1301

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

\item

1320

1302

\item

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

1321

1303

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

\item

1322

1304

\item

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

1323

1305

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

hidden.}

1324

1306

hidden.}

\item

1325

1307

\item

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

1326

1308

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

only that User.}

1327

1309

only that User.}

\end{enumerate}

1328

1310

\end{enumerate}

1329

1311

\end{description}

1330

1312

\end{description}

1331

1313

\newpage

1332

1314

\newpage

1333

1315

{}

1334

1316

{}

1335

1317

\subsection{[F9] View a Feed}

1336

1318

\subsection{[F9] View a Feed}

1337

1319

\begin{description}

1338

1320

\begin{description}

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

1339

1321

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

classes}

1340

1322

classes}

1341

1323

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

1342

1324

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

specific classes. }

1343

1325

specific classes. }

\\

1344

1326

\\

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

1345

1327

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

1346

1328

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

1347

1329

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

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

1348

1330

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

\\

1349

1331

\\

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

1350

1332

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

1351

1333

{Status:}{Not implemented}

1352

1334

{Status:}{Not implemented}

1353

1335

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

1354

1336

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

1355

1337

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

1356

1338

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

1357

1339

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

1358

1340

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

1359

1341

\item[Workflow]

1360

1342

\item[Workflow]

1361

1343

\begin{enumerate}

1362

1344

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1363

1345

\itemsep1pt\parskip0pt\parsep0pt

\item

1364

1346

\item

{The User logs into their account.}

1365

1347

{The User logs into their account.}

\item

1366

1348

\item

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

1367

1349

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

\item

1368

1350

\item

{The User is at their dashboard.}

1369

1351

{The User is at their dashboard.}

\item

1370

1352

\item

{The Client shows the User's dashboard.}

1371

1353

{The Client shows the User's dashboard.}

\item

1372

1354

\item

{The User selects a class from their dashboard.}

1373

1355

{The User selects a class from their dashboard.}

\item

1374

1356

\item

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

1375

1357

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

\end{enumerate}

1376

1358

\end{enumerate}

1377

1359

\end{description}

1378

1360

\end{description}

\newpage

1379

1361

\newpage

1380

1362

{}

1381

1363

{}

\section{Decks}

1382

1364

\section{Decks}

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

1383

1365

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

1384

1366

\begin{description}

1385

1367

\begin{description}

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

1386

1368

\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

1369

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

new flashcard.}

1388

1370

new flashcard.}

1389

1371

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

1390

1372

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

\\

1391

1373

\\

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

1392

1374

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

1393

1375

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

1394

1376

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

1395

1377

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

1396

1378

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

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

1397

1379

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

\\

1398

1380

\\

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

1399

1381

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

1400

1382

\item[Status]{In Progress}

1401

1383

\item[Status]{In Progress}

1402

1384

\item[Pre-conditions]

1403

1385

\item[Pre-conditions]

1404

1386

\begin{itemize}

1405

1387

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1406

1388

\itemsep1pt\parskip0pt\parsep0pt

\item

1407

1389

\item

{The user has an account with the application. }

1408

1390

{The user has an account with the application. }

\item

1409

1391

\item

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

1410

1392

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

\end{itemize}

1411

1393

\end{itemize}

1412

1394

\item[Post-conditions]

1413

1395

\item[Post-conditions]

1414

1396

\begin{itemize}

1415

1397

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1416

1398

\itemsep1pt\parskip0pt\parsep0pt

\item

1417

1399

\item

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

1418

1400

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

\item

1419

1401

\item

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

1420

1402

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

\end{itemize}

1421

1403

\end{itemize}

1422

1404

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

1423

1405

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

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

1424

1406

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

1425

1407

\item[Workflow]

1426

1408

\item[Workflow]

1427

1409

\begin{enumerate}

1428

1410

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1429

1411

\itemsep1pt\parskip0pt\parsep0pt

\item

1430

1412

\item

{User is at their dashboard.}

1431

1413

{User is at their dashboard.}

\item

1432

1414

\item

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

1433

1415

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

\item

1434

1416

\item

{Client displays the Live Feed for the class.}

1435

1417

{Client displays the Live Feed for the class.}

\item

1436

1418

\item

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

1437

1419

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

in their Deck.}

1438

1420

in their Deck.}

\item

1439

1421

\item

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

1440

1422

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

\item

1441

1423

\item

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

1442

1424

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

\item

1443

1425

\item

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

1444

1426

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

\item

1445

1427

\item

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

1446

1428

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

\end{enumerate}

1447

1429

\end{enumerate}

1448

1430

{Alternate Workflow:}

1449

1431

{Alternate Workflow:}

1450

1432

\begin{enumerate}

1451

1433

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1452

1434

\itemsep1pt\parskip0pt\parsep0pt

\item

1453

1435

\item

{User is at their dashboard.}

1454

1436

{User is at their dashboard.}

\item

1455

1437

\item

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

1456

1438

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

\item

1457

1439

\item

{Client displays the Live Feed for the class.}

1458

1440

{Client displays the Live Feed for the class.}

\item

1459

1441

\item

{The User adds a Flashcard into the Class.}

1460

1442

{The User adds a Flashcard into the Class.}

\item

1461

1443

\item

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

1462

1444

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

\item

1463

1445

\item

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

1464

1446

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

\item

1465

1447

\item

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

1466

1448

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

\item

1467

1449

\item

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

1468

1450

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

\end{enumerate}

1469

1451

\end{enumerate}

\end{description}

1470

1452

\end{description}

\newpage

1471

1453

\newpage

1472

1454

{}

1473

1455

{}

1474

1456

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

1475

1457

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

1476

1458

\begin{description}

1477

1459

\begin{description}

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

1478

1460

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

1479

1461

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

1480

1462

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

\\

1481

1463

\\

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

1482

1464

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

1483

1465

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

1484

1466

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

1485

1467

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

1486

1468

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

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

1487

1469

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

\\

1488

1470

\\

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

1489

1471

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

1490

1472

\item[Status]{Unimplemented}

1491

1473

\item[Status]{Unimplemented}

1492

1474

\item[Pre-conditions]

1493

1475

\item[Pre-conditions]

1494

1476

\begin{itemize}

1495

1477

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1496

1478

\itemsep1pt\parskip0pt\parsep0pt

\item

1497

1479

\item

{The User has an account with the application}

1498

1480

{The User has an account with the application}

\item

1499

1481

\item

{The User is logged in}

1500

1482

{The User is logged in}

\end{itemize}

1501

1483

\end{itemize}

1502

1484

\item[Post-conditions]

1503

1485

\item[Post-conditions]

1504

1486

\begin{itemize}

1505

1487

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1506

1488

\itemsep1pt\parskip0pt\parsep0pt

\item

1507

1489

\item

{Desired cards are hidden to the user.}

1508

1490

{Desired cards are hidden to the user.}

\end{itemize}

1509

1491

\end{itemize}

1510

1492

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

1511

1493

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

1512

1494

\item[Workflow]

1513

1495

\item[Workflow]

1514

1496

\begin{enumerate}

1515

1497

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1516

1498

\itemsep1pt\parskip0pt\parsep0pt

\item

1517

1499

\item

{The Client shows the user the dashboard.}

1518

1500

{The Client shows the user the dashboard.}

\item

1519

1501

\item

{The User shall select the appropriate class.}

1520

1502

{The User shall select the appropriate class.}

\item

1521

1503

\item

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

1522

1504

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

\item

1523

1505

\item

{The User shall select deck view.}

1524

1506

{The User shall select deck view.}

\item

1525

1507

\item

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

1526

1508

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

\item

1527

1509

\item

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

1528

1510

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

\item

1529

1511

\item

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

1530

1512

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

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

1531

1513

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

\item

1532

1514

\item

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

1533

1515

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

\item

1534

1516

\item

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

1535

1517

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

\item

1536

1518

\item

{The Client updates the User's Deck.}

1537

1519

{The Client updates the User's Deck.}

\end{enumerate}

1538

1520

\end{enumerate}

1539

1521

{}

1540

1522

{}

1541

1523

{Alternate Workflow:}

1542

1524

{Alternate Workflow:}

1543

1525

\begin{enumerate}

1544

1526

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1545

1527

\itemsep1pt\parskip0pt\parsep0pt

\item

1546

1528

\item

{The Client shows the user the dashboard.}

1547

1529

{The Client shows the user the dashboard.}

\item

1548

1530

\item

{The User shall select the appropriate class.}

1549

1531

{The User shall select the appropriate class.}

\item

1550

1532

\item

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

1551

1533

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

\item

1552

1534

\item

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

1553

1535

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

\item

1554

1536

\item

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

1555

1537

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

\item

1556

1538

\item

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

1557

1539

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

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

1558

1540

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

\item

1559

1541

\item

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

1560

1542

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

\item

1561

1543

\item

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

1562

1544

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

\item

1563

1545

\item

{The Client updates the User's Deck.}

1564

1546

{The Client updates the User's Deck.}

\end{enumerate}

1565

1547

\end{enumerate}

\end{description}

1566

1548

\end{description}

1567

1549

\subsection{[-D2-] Shuffling deck}

1568

1550

\subsection{[-D2-] Shuffling deck}

1569

1551

\begin{description}

1570

1552

\begin{description}

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

1571

1553

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

the flashcards}

1572

1554

the flashcards}

1573

1555

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

1574

1556

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

flashcards appear in random order}

1575

1557

flashcards appear in random order}

1576

1558

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

1577

1559

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

1578

1560

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

1579

1561

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

1580

1562

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

1581

1563

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

\\

1582

1564

\\

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

1583

1565

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

1584

1566

\item[Status]{Implemented }

1585

1567

\item[Status]{Implemented }

1586

1568

\item[Pre-conditions]

1587

1569

\item[Pre-conditions]

1588

1570

\begin{itemize}

1589

1571

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1590

1572

\itemsep1pt\parskip0pt\parsep0pt

\item

1591

1573

\item

{User must have registered for course }

1592

1574

{User must have registered for course }

\end{itemize}

1593

1575

\end{itemize}

1594

1576

\begin{itemize}

1595

1577

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1596

1578

\itemsep1pt\parskip0pt\parsep0pt

\item

1597

1579

\item

{User must have added cards to deck}

1598

1580

{User must have added cards to deck}

\end{itemize}

1599

1581

\end{itemize}

1600

1582

\item[Post-conditions]{}

1601

1583

\item[Post-conditions]{}

1602

1584

\begin{itemize}

1603

1585

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1604

1586

\itemsep1pt\parskip0pt\parsep0pt

\item

1605

1587

\item

{User takes a quiz and notice the deck has been shuffled}

1606

1588

{User takes a quiz and notice the deck has been shuffled}

\end{itemize}

1607

1589

\end{itemize}

1608

1590

\item[Trigger]{User has clicked on the button ``SHUFFLE DECK''}

1609

1591

\item[Trigger]{User has clicked on the button ``SHUFFLE DECK''}

1610

1592

\item[Workflow]

1611

1593

\item[Workflow]

1612

1594

\begin{enumerate}

1613

1595

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1614

1596

\itemsep1pt\parskip0pt\parsep0pt

\item

1615

1597

\item

{User is on the homepage.}

1616

1598

{User is on the homepage.}

\item

1617

1599

\item

{User selects the ``Study'' button for the Class they want to view or

1618

1600

{User selects the ``Study'' button for the Class they want to view or

shuffle cards for.}

1619

1601

shuffle cards for.}

\item

1620

1602

\item

{The Client displays their Deck for the Class of interest.}

1621

1603

{The Client displays their Deck for the Class of interest.}

\item

1622

1604

\item

{User clicks on ``shuffle deck'' button to shuffle the deck,

1623

1605

{User clicks on ``shuffle deck'' button to shuffle the deck,

randomizing the order in which it will be displayed.}

1624

1606

randomizing the order in which it will be displayed.}

\item

1625

1607

\item

{The Client displays a change in card ordering.}

1626

1608

{The Client displays a change in card ordering.}

\item

1627

1609

\item

{System reorders cards' study order.}

1628

1610

{System reorders cards' study order.}

GITLAB

110swag / docs

Merge branch 'master' of git.ucsd.edu:110swag/docs