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 '+' button at the bottom right of the screen.}

778

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

\item

779

\item

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

780

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

\item

781

\item

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

782

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

\item

783

\item

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

784

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

\item

785

\item

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

786

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

\item {The frontend shallsubmit the flashcard text,

787

\item {The frontend shallsubmit the flashcard text,

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

788

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

\item

789

\item

{The backend shall obtain the flashcard information by deserializing

790

{The backend shall obtain the flashcard information by deserializing

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

791

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

\item

792

\item

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

793

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

Flashcards table in the database in models.py.}

794

Flashcards table in the database in models.py.}

\item

795

\item

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

796

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

the class using FeedController.js.}

797

the class using FeedController.js.}

\end{enumerate}

798

\end{enumerate}

\end{description}

799

\end{description}

\newpage

800

\newpage

{}

801

{}

802

\subsection{[F2] Edit Flashcard}

803

\subsection{[F2] Edit Flashcard}

804

\begin{description}

805

\begin{description}

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

806

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

flashcard }

807

808

807

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

809

808

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

\\

810

809

\\

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

811

810

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

812

811

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

813

812

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

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

814

813

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

Flashcard}

815

814

Flashcard}

816

815

\item[Pre-conditions]

817

816

\item[Pre-conditions]

818

817

\begin{itemize}

819

818

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

820

819

\itemsep1pt\parskip0pt\parsep0pt

\item

821

820

\item

{Flashcard is created.}

822

821

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

\item

823

822

\item

{Flashcard in user's deck.}

824

823

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

\item

825

{Flashcard is viewable.}

826

\end{itemize}

827

824

\end{itemize}

828

825

\item[Post-conditions]

829

826

\item[Post-conditions]

830

827

\begin{itemize}

831

828

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

832

829

\itemsep1pt\parskip0pt\parsep0pt

\item

833

830

\item

{Flashcard is edited.}

834

831

{A duplicate flashcard with some differences is created.}

\end{itemize}

835

832

\end{itemize}

836

833

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

837

834

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

\item[Workflow]

838

835

\item[Workflow]

839

836

\begin{enumerate}

840

837

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

841

838

\itemsep1pt\parskip0pt\parsep0pt

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

842

839

\item{The user shall hover over the card to be edited and and click on the

840

pencil button that appears on the bottom left of the card.}

\item

843

841

\item

{The frontend shall produce an editable dialog box containing flashcard

844

842

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

text }

845

843

text }

\item

846

844

\item

{The user shall make desired changes}

847

845

{The user shall make desired changes}

\item

848

846

\item

{The user shall click `Save'}

849

847

{The user shall click `Save Changes'}

\item

850

848

\item

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

851

849

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

it to the server}

852

850

it to the server at /api/flashcards/}

\item

853

851

\item

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

854

852

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

create a new FlashcardMask object and update the appropriate

855

853

create a new FlashcardMask object and update the appropriate

UserFlashcard object with a reference to it.}

856

854

UserFlashcard object with a reference to it.}

\item

857

855

\item

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

858

856

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

\end{enumerate}

859

857

\end{enumerate}

860

858

\begin{enumerate}

861

859

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

862

860

\itemsep1pt\parskip0pt\parsep0pt

\item

863

861

\item

{create a new flashcard for the section}

864

862

{create a new flashcard for the section}

\item

865

863

\item

{push it to the feed}

866

864

{push it to the feed}

\item

867

865

\item

{add it to the user's deck}

868

866

{add it to the user's deck}

\item

869

867

\item

{hide the old card from the user}

870

868

{hide the old card from the user}

\item

871

869

\item

{and return the new card to the user}

872

870

{and return the new card to the user}

\end{enumerate}

873

871

\end{enumerate}

\end{description}

874

872

\end{description}

{}

875

873

{}

876

874

\newpage

877

875

\newpage

878

876

{}

879

877

{}

880

878

\subsection{[F3] Pull Flashcard}

881

879

\subsection{[F3] Pull Flashcard}

\begin{description}

882

880

\begin{description}

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

883

881

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

deck from the Live Feed. }

884

882

deck from the Live Feed. }

885

883

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

886

884

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

deck }

887

885

deck }

\\

888

886

\\

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

889

887

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

890

888

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

891

889

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

892

890

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

893

891

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

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

894

892

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

\\

895

893

\\

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

896

894

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

897

895

\item[Status]{Implemented}

898

896

\item[Status]{Implemented}

899

897

\item[Pre-conditions]

900

898

\item[Pre-conditions]

901

899

\begin{itemize}

902

900

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

903

901

\itemsep1pt\parskip0pt\parsep0pt

\item

904

902

\item

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

905

903

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

\item

906

904

\item

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

907

905

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

\end{itemize}

908

906

\end{itemize}

909

907

\item[Post-conditions]

910

908

\item[Post-conditions]

911

909

\begin{itemize}

912

910

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

913

911

\itemsep1pt\parskip0pt\parsep0pt

\item

914

912

\item

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

915

913

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

\item

916

914

\item

{User can review this flashcard later.}

917

915

{User can review this flashcard later.}

\end{itemize}

918

916

\end{itemize}

919

917

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

920

918

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

921

919

\item[Workflow]

922

920

\item[Workflow]

923

921

\begin{enumerate}

924

922

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

925

923

\itemsep1pt\parskip0pt\parsep0pt

\item

926

924

\item

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

927

925

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

the Feed.}

928

926

the Feed.}

\item

929

927

\item

{The frontend shall }

930

928

{The frontend shall }

\item

931

929

\item

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

932

930

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

on the sidebar.}

933

931

on the sidebar.}

\item

934

932

\item

{The Client shall submit a POST request to

935

933

{The Client shall submit a POST request to

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

936

934

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

\item

937

935

\item

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

938

936

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

user's deck contains the card.}

939

937

user's deck contains the card.}

\item

940

938

\item

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

941

939

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

if any}

942

940

if any}

\item

943

941

\item

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

944

942

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

rearranging the feed.}

945

943

rearranging the feed.}

\end{enumerate}

946

944

\end{enumerate}

\end{description}

947

945

\end{description}

\newpage

948

946

\newpage

949

947

{}

950

948

{}

951

949

\subsection{[F4] Flag Inappropriate Cards}

952

950

\subsection{[F4] Flag Inappropriate Cards}

953

951

\begin{description}

954

952

\begin{description}

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

955

953

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

956

954

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

957

955

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

adjusted.}

958

956

adjusted.}

\\

959

957

\\

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

960

958

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

should not be displayed in the feed.}

961

959

should not be displayed in the feed.}

962

960

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

963

961

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

964

962

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

965

963

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

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

966

964

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

\\

967

965

\\

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

968

966

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

969

967

\item[Status]{Implemented}

970

968

\item[Status]{Implemented}

971

969

\item[Pre-conditions]

972

970

\item[Pre-conditions]

973

971

\begin{itemize}

974

972

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

975

973

\itemsep1pt\parskip0pt\parsep0pt

\item

976

974

\item

{User is enrolled in a class}

977

975

{User is enrolled in a class}

\end{itemize}

978

976

\end{itemize}

979

977

\begin{itemize}

980

978

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

981

979

\itemsep1pt\parskip0pt\parsep0pt

\item

982

980

\item

{Flashcard is created.}

983

981

{Flashcard is created.}

\item

984

982

\item

{Flashcard is viewable in feed.}

985

983

{Flashcard is viewable in feed.}

\item

986

984

\item

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

987

985

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

\end{itemize}

988

986

\end{itemize}

989

987

\item[Post-conditions]

990

988

\item[Post-conditions]

991

989

\begin{itemize}

992

990

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

993

991

\itemsep1pt\parskip0pt\parsep0pt

\item

994

992

\item

{Flashcard is hidden from user.}

995

993

{Flashcard is hidden from user.}

\item

996

994

\item

{Flashcard internal variable is adjusted.}

997

995

{Flashcard internal variable is adjusted.}

\end{itemize}

998

996

\end{itemize}

999

997

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

1000

998

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

1001

999

\item[Workflow]

1002

1000

\item[Workflow]

1003

1001

\begin{enumerate}

1004

1002

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1005

1003

\itemsep1pt\parskip0pt\parsep0pt

\item {

1006

1004

\item {

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

1007

1005

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

\item

1008

1006

\item

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

1009

1007

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

\item

1010

1008

\item

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

1011

1009

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

\item

1012

1010

\item

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

1013

1011

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

\item

1014

1012

\item

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

1015

1013

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

\end{enumerate}

1016

1014

\end{enumerate}

\end{description}

1017

1015

\end{description}

{}

1018

1016

{}

1019

1017

{}

1020

1018

{}

1021

1019

\newpage

1022

1020

\newpage

1023

1021

{}

1024

1022

{}

1025

1023

\subsection{[F5] Filter Flashcards - Deferred}

1026

1024

\subsection{[F5] Filter Flashcards - Deferred}

1027

1025

\begin{description}

1028

1026

\begin{description}

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

1029

1027

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

1030

1028

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

1031

1029

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

options.}

1032

1030

options.}

1033

1031

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

1034

1032

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

for.}

1035

1033

for.}

1036

1034

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

1037

1035

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

1038

1036

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

1039

1037

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

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

1040

1038

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

Flashcard}

1041

1039

Flashcard}

\\

1042

1040

\\

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

1043

1041

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

1044

1042

\item[Status]{Not Implemented }

1045

1043

\item[Status]{Not Implemented }

1046

1044

\item[Pre-conditions]

1047

1045

\item[Pre-conditions]

1048

1046

\begin{itemize}

1049

1047

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1050

1048

\itemsep1pt\parskip0pt\parsep0pt

\item

1051

1049

\item

{User has added the class.}

1052

1050

{User has added the class.}

\item

1053

1051

\item

{Flashcards exist in the course.}

1054

1052

{Flashcards exist in the course.}

\item

1055

1053

\item

{The User has navigated to the study page.}

1056

1054

{The User has navigated to the study page.}

\end{itemize}

1057

1055

\end{itemize}

1058

1056

\item[Post-conditions]{}

1059

1057

\item[Post-conditions]{}

1060

1058

\begin{itemize}

1061

1059

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1062

1060

\itemsep1pt\parskip0pt\parsep0pt

\item

1063

1061

\item

{User only sees specific flashcards}

1064

1062

{User only sees specific flashcards}

\end{itemize}

1065

1063

\end{itemize}

1066

1064

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

1067

1065

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

1068

1066

\item[Workflow]

1069

1067

\item[Workflow]

1070

1068

\begin{enumerate}

1071

1069

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1072

1070

\itemsep1pt\parskip0pt\parsep0pt

\item

1073

1071

\item

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

1074

1072

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

\item

1075

1073

\item

{The User fills in the date fields.}

1076

1074

{The User fills in the date fields.}

\item

1077

1075

\item

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

1078

1076

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

\item

1079

1077

\item

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

1080

1078

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

1081

1079

\end{enumerate}

1082

1080

\end{enumerate}

\end{description}

1083

1081

\end{description}

{}

1084

1082

{}

1085

1083

\newpage

1086

1084

\newpage

1087

1085

{}

1088

1086

{}

1089

1087

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

1090

1088

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

1091

1089

\begin{description}

1092

1090

\begin{description}

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

1093

1091

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

flashcard in his deck. }

1094

1092

flashcard in his deck. }

1095

1093

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

1096

1094

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

System that they are keywords. }

1097

1095

System that they are keywords. }

\\

1098

1096

\\

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

1099

1097

\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

1100

1098

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

User guess what they are.}

1101

1099

User guess what they are.}

1102

1100

{Primary Actor: }{User (student)}

1103

1101

{Primary Actor: }{User (student)}

1104

1102

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

1105

1103

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

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

1106

1104

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

\\

1107

1105

\\

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

1108

1106

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

1109

1107

\item[Status]{Implemented.}

1110

1108

\item[Status]{Implemented.}

1111

1109

\item[Pre-conditions]

1112

1110

\item[Pre-conditions]

1113

1111

\begin{itemize}

1114

1112

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1115

1113

\itemsep1pt\parskip0pt\parsep0pt

\item

1116

1114

\item

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

1117

1115

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

\item

1118

1116

\item

{The User shall be on the Live Feed for the class.}

1119

1117

{The User shall be on the Live Feed for the class.}

\item

1120

1118

\item

{The User has clicked the 'c' hotkey or the 'plus' button to start making a card.}

1121

1119

{The User has clicked the 'c' hotkey or the 'plus' button to start making a card.}

\item

1122

1120

\item

{The User shall type in information relevant to their class.}

1123

1121

{The User shall type in information relevant to their class.}

\end{itemize}

1124

1122

\end{itemize}

1125

1123

{Post-conditions: }

1126

1124

{Post-conditions: }

1127

1125

\begin{itemize}

1128

1126

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1129

1127

\itemsep1pt\parskip0pt\parsep0pt

\item

1130

1128

\item

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

1131

1129

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

\item

1132

1130

\item

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

1133

1131

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

1134

1132

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

\end{itemize}

1135

1133

\end{itemize}

1136

1134

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

1137

1135

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

1138

1136

\item[Workflow]

1139

1137

\item[Workflow]

1140

1138

\begin{enumerate}

1141

1139

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1142

1140

\itemsep1pt\parskip0pt\parsep0pt

\item

1143

1141

\item

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

1144

1142

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

\item

1145

1143

\item

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

1146

1144

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

\item

1147

1145

\item

{The backend shall mark those words by updating the field mask for

1148

1146

{The backend shall mark those words by updating the field mask for

that userflashcard object in views.py in function create. }

1149

1147

that userflashcard object in views.py in function create. }

\item

1150

1148

\item

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

1151

1149

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

\item

1152

1150

\item

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

1153

1151

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

\end{enumerate}

1154

1152

\end{enumerate}

1155

1153

{Alternative Workflows:}

1156

1154

{Alternative Workflows:}

1157

1155

\begin{enumerate}

1158

1156

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1159

1157

\itemsep1pt\parskip0pt\parsep0pt

\item

1160

1158

\item

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

1161

1159

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

\item

1162

1160

\item

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

1163

1161

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

\item

1164

1162

\item

{The backend shall mark those words by updating the field mask for

1165

1163

{The backend shall mark those words by updating the field mask for

that userflashcard object in views.py in function create. }

1166

1164

that userflashcard object in views.py in function create. }

\item

1167

1165

\item

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

1168

1166

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

\item

1169

1167

\item

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

1170

1168

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

1171

1169

\end{enumerate}

1172

1170

\end{enumerate}

\end{description}

1173

1171

\end{description}

{}

1174

1172

{}

1175

1173

\newpage

1176

1174

\newpage

1177

1175

{}

1178

1176

{}

1179

1177

\subsection{[F7] Fix Flashcard}

1180

1178

\subsection{[F7] Fix Flashcard}

1181

1179

\begin{description}

1182

1180

\begin{description}

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

1183

1181

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

1184

1182

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

1185

1183

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

1186

1184

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

alteration will be shown to all users of that flashcard}

1187

1185

alteration will be shown to all users of that flashcard}

\\

1188

1186

\\

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

1189

1187

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

than it did originally.}

1190

1188

than it did originally.}

1191

1189

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

1192

1190

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

1193

1191

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

1194

1192

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

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

1195

1193

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

\\

1196

1194

\\

\item[Priority Level]{Must}

1197

1195

\item[Priority Level]{Must}

1198

1196

\item[Status]{Not Implemented}

1199

1197

\item[Status]{Not Implemented}

1200

1198

\item[Pre-conditions]

1201

1199

\item[Pre-conditions]

1202

1200

\begin{itemize}

1203

1201

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1204

1202

\itemsep1pt\parskip0pt\parsep0pt

\item

1205

1203

\item

{User has created the flashcard}

1206

1204

{User has created the flashcard}

\end{itemize}

1207

1205

\end{itemize}

1208

1206

\item[Post-conditions]{}

1209

1207

\item[Post-conditions]{}

1210

1208

\begin{itemize}

1211

1209

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1212

1210

\itemsep1pt\parskip0pt\parsep0pt

\item

1213

1211

\item

{The user shall see their alteration for that flashcard}

1214

1212

{The user shall see their alteration for that flashcard}

\item

1215

1213

\item

{Other users will be notified of the alteration}

1216

1214

{Other users will be notified of the alteration}

\end{itemize}

1217

1215

\end{itemize}

1218

1216

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

1219

1217

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

``Edit''}

1220

1218

``Edit''}

1221

1219

\item[Workflow]

1222

1220

\item[Workflow]

1223

1221

\begin{enumerate}

1224

1222

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1225

1223

\itemsep1pt\parskip0pt\parsep0pt

\item

1226

1224

\item

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

1227

1225

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

\item

1228

1226

\item

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

1229

1227

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

\item

1230

1228

\item

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

1231

1229

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

\item

1232

1230

\item

{The Flashcard will display editable fields/areas.}

1233

1231

{The Flashcard will display editable fields/areas.}

\item

1234

1232

\item

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

1235

1233

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

\item

1236

1234

\item

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

1237

1235

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

\item

1238

1236

\item

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

1239

1237

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

\item

1240

1238

\item

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

1241

1239

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

\item

1242

1240

\item

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

1243

1241

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

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

1244

1242

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

changes.}

1245

1243

changes.}

\end{enumerate}

1246

1244

\end{enumerate}

\end{description}

1247

1245

\end{description}

{}

1248

1246

{}

1249

1247

{}

1250

1248

{}

1251

1249

{}

1252

1250

{}

1253

1251

\newpage

1254

1252

\newpage

1255

1253

{}

1256

1254

{}

1257

1255

\subsection{[F8] Hide cards from feed}

1258

1256

\subsection{[F8] Hide cards from feed}

1259

1257

\begin{description}

1260

1258

\begin{description}

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

1261

1259

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

1262

1260

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

1263

1261

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

\\

1264

1262

\\

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

1265

1263

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

reduce screen clutter}

1266

1264

reduce screen clutter}

1267

1265

{Primary Actor: }{User (Student)}

1268

1266

{Primary Actor: }{User (Student)}

1269

1267

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

1270

1268

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

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

1271

1269

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

\\

1272

1270

\\

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

1273

1271

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

1274

1272

{Status:}{Not implemented}

1275

1273

{Status:}{Not implemented}

1276

1274

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

1277

1275

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

1278

1276

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

1279

1277

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

1280

1278

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

1281

1279

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

1282

1280

\item[Workflow]

1283

1281

\item[Workflow]

1284

1282

\begin{enumerate}

1285

1283

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1286

1284

\itemsep1pt\parskip0pt\parsep0pt

\item

1287

1285

\item

{The User chooses a class from the dashboard.}

1288

1286

{The User chooses a class from the dashboard.}

\item

1289

1287

\item

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

1290

1288

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

\item

1291

1289

\item

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

1292

1290

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

\item

1293

1291

\item

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

1294

1292

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

hidden.}

1295

1293

hidden.}

\item

1296

1294

\item

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

1297

1295

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

only that User.}

1298

1296

only that User.}

\end{enumerate}

1299

1297

\end{enumerate}

1300

1298

\end{description}

1301

1299

\end{description}

1302

1300

\newpage

1303

1301

\newpage

1304

1302

{}

1305

1303

{}

1306

1304

\subsection{[F9] View a Feed}

1307

1305

\subsection{[F9] View a Feed}

1308

1306

\begin{description}

1309

1307

\begin{description}

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

1310

1308

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

classes}

1311

1309

classes}

1312

1310

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

1313

1311

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

specific classes. }

1314

1312

specific classes. }

\\

1315

1313

\\

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

1316

1314

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

1317

1315

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

1318

1316

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

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

1319

1317

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

\\

1320

1318

\\

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

1321

1319

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

1322

1320

{Status:}{Not implemented}

1323

1321

{Status:}{Not implemented}

1324

1322

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

1325

1323

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

1326

1324

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

1327

1325

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

1328

1326

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

1329

1327

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

1330

1328

\item[Workflow]

1331

1329

\item[Workflow]

1332

1330

\begin{enumerate}

1333

1331

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1334

1332

\itemsep1pt\parskip0pt\parsep0pt

\item

1335

1333

\item

{The User logs into their account.}

1336

1334

{The User logs into their account.}

\item

1337

1335

\item

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

1338

1336

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

\item

1339

1337

\item

{The User is at their dashboard.}

1340

1338

{The User is at their dashboard.}

\item

1341

1339

\item

{The Client shows the User's dashboard.}

1342

1340

{The Client shows the User's dashboard.}

\item

1343

1341

\item

{The User selects a class from their dashboard.}

1344

1342

{The User selects a class from their dashboard.}

\item

1345

1343

\item

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

1346

1344

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

\end{enumerate}

1347

1345

\end{enumerate}

1348

1346

\end{description}

1349

1347

\end{description}

\newpage

1350

1348

\newpage

1351

1349

{}

1352

1350

{}

\section{Decks}

1353

1351

\section{Decks}

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

1354

1352

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

1355

1353

\begin{description}

1356

1354

\begin{description}

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

1357

1355

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

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

1358

1356

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

new flashcard.}

1359

1357

new flashcard.}

1360

1358

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

1361

1359

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

\\

1362

1360

\\

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

1363

1361

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

1364

1362

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

1365

1363

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

1366

1364

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

1367

1365

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

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

1368

1366

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

\\

1369

1367

\\

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

1370

1368

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

1371

1369

\item[Status]{In Progress}

1372

1370

\item[Status]{In Progress}

1373

1371

\item[Pre-conditions]

1374

1372

\item[Pre-conditions]

1375

1373

\begin{itemize}

1376

1374

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1377

1375

\itemsep1pt\parskip0pt\parsep0pt

\item

1378

1376

\item

{The user has an account with the application. }

1379

1377

{The user has an account with the application. }

\item

1380

1378

\item

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

1381

1379

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

\end{itemize}

1382

1380

\end{itemize}

1383

1381

\item[Post-conditions]

1384

1382

\item[Post-conditions]

1385

1383

\begin{itemize}

1386

1384

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1387

1385

\itemsep1pt\parskip0pt\parsep0pt

\item

1388

1386

\item

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

1389

1387

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

\item

1390

1388

\item

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

1391

1389

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

\end{itemize}

1392

1390

\end{itemize}

1393

1391

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

1394

1392

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

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

1395

1393

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

1396

1394

\item[Workflow]

1397

1395

\item[Workflow]

1398

1396

\begin{enumerate}

1399

1397

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1400

1398

\itemsep1pt\parskip0pt\parsep0pt

\item

1401

1399

\item

{User is at their dashboard.}

1402

1400

{User is at their dashboard.}

\item

1403

1401

\item

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

1404

1402

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

\item

1405

1403

\item

{Client displays the Live Feed for the class.}

1406

1404

{Client displays the Live Feed for the class.}

\item

1407

1405

\item

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

1408

1406

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

in their Deck.}

1409

1407

in their Deck.}

\item

1410

1408

\item

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

1411

1409

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

\item

1412

1410

\item

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

1413

1411

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

\item

1414

1412

\item

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

1415

1413

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

\item

1416

1414

\item

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

1417

1415

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

\end{enumerate}

1418

1416

\end{enumerate}

1419

1417

{Alternate Workflow:}

1420

1418

{Alternate Workflow:}

1421

1419

\begin{enumerate}

1422

1420

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1423

1421

\itemsep1pt\parskip0pt\parsep0pt

\item

1424

1422

\item

{User is at their dashboard.}

1425

1423

{User is at their dashboard.}

\item

1426

1424

\item

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

1427

1425

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

\item

1428

1426

\item

{Client displays the Live Feed for the class.}

1429

1427

{Client displays the Live Feed for the class.}

\item

1430

1428

\item

{The User adds a Flashcard into the Class.}

1431

1429

{The User adds a Flashcard into the Class.}

\item

1432

1430

\item

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

1433

1431

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

\item

1434

1432

\item

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

1435

1433

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

\item

1436

1434

\item

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

1437

1435

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

\item

1438

1436

\item

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

1439

1437

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

\end{enumerate}

1440

1438

\end{enumerate}

\end{description}

1441

1439

\end{description}

\newpage

1442

1440

\newpage

1443

1441

{}

1444

1442

{}

1445

1443

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

1446

1444

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

1447

1445

\begin{description}

1448

1446

\begin{description}

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

1449

1447

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

1450

1448

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

1451

1449

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

\\

1452

1450

\\

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

1453

1451

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

1454

1452

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

1455

1453

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

1456

1454

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

1457

1455

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

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

1458

1456

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

\\

1459

1457

\\

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

1460

1458

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

1461

1459

\item[Status]{Unimplemented}

1462

1460

\item[Status]{Unimplemented}

1463

1461

\item[Pre-conditions]

1464

1462

\item[Pre-conditions]

1465

1463

\begin{itemize}

1466

1464

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1467

1465

\itemsep1pt\parskip0pt\parsep0pt

\item

1468

1466

\item

{The User has an account with the application}

1469

1467

{The User has an account with the application}

\item

1470

1468

\item

{The User is logged in}

1471

1469

{The User is logged in}

\end{itemize}

1472

1470

\end{itemize}

1473

1471

\item[Post-conditions]

1474

1472

\item[Post-conditions]

1475

1473

\begin{itemize}

1476

1474

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1477

1475

\itemsep1pt\parskip0pt\parsep0pt

\item

1478

1476

\item

{Desired cards are hidden to the user.}

1479

1477

{Desired cards are hidden to the user.}

\end{itemize}

1480

1478

\end{itemize}

1481

1479

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

1482

1480

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

1483

1481

\item[Workflow]

1484

1482

\item[Workflow]

1485

1483

\begin{enumerate}

1486

1484

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1487

1485

\itemsep1pt\parskip0pt\parsep0pt

\item

1488

1486

\item

{The Client shows the user the dashboard.}

1489

1487

{The Client shows the user the dashboard.}

\item

1490

1488

\item

{The User shall select the appropriate class.}

1491

1489

{The User shall select the appropriate class.}

\item

1492

1490

\item

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

1493

1491

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

\item

1494

1492

\item

{The User shall select deck view.}

1495

1493

{The User shall select deck view.}

\item

1496

1494

\item

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

1497

1495

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

\item

1498

1496

\item

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

1499

1497

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

\item

1500

1498

\item

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

1501

1499

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

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

1502

1500

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

\item

1503

1501

\item

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

1504

1502

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

\item

1505

1503

\item

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

1506

1504

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

\item

1507

1505

\item

{The Client updates the User's Deck.}

1508

1506

{The Client updates the User's Deck.}

\end{enumerate}

1509

1507

\end{enumerate}

1510

1508

{}

1511

1509

{}

1512

1510

{Alternate Workflow:}

1513

1511

{Alternate Workflow:}

1514

1512

\begin{enumerate}

1515

1513

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1516

1514

\itemsep1pt\parskip0pt\parsep0pt

\item

1517

1515

\item

{The Client shows the user the dashboard.}

1518

1516

{The Client shows the user the dashboard.}

\item

1519

1517

\item

{The User shall select the appropriate class.}

1520

1518

{The User shall select the appropriate class.}

\item

1521

1519

\item

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

1522

1520

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

\item

1523

1521

\item

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

1524

1522

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

\item

1525

1523

\item

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

1526

1524

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

\item

1527

1525

\item

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

1528

1526

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

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

1529

1527

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

\item

1530

1528

\item

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

1531

1529

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

\item

1532

1530

\item

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

1533

1531

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

\item

1534

1532

\item

{The Client updates the User's Deck.}

1535

1533

{The Client updates the User's Deck.}

\end{enumerate}

1536

1534

\end{enumerate}

\end{description}

1537

1535

\end{description}

1538

1536

\subsection{[-D2-] Shuffling deck}

1539

1537

\subsection{[-D2-] Shuffling deck}

1540

1538

\begin{description}

1541

1539

\begin{description}

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

1542

1540

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

the flashcards}

1543

1541

the flashcards}

1544

1542

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

1545

1543

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

flashcards appear in random order}

1546

1544

flashcards appear in random order}

1547

1545

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

1548

1546

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

1549

1547

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

1550

1548

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

1551

1549

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

1552

1550

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

\\

1553

1551

\\

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

1554

1552

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

1555

1553

\item[Status]{Implemented }

1556

1554

\item[Status]{Implemented }

1557

1555

\item[Pre-conditions]

1558

1556

\item[Pre-conditions]

1559

1557

\begin{itemize}

1560

1558

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1561

1559

\itemsep1pt\parskip0pt\parsep0pt

\item

1562

1560

\item

{User must have registered for course }

1563

1561

{User must have registered for course }

\end{itemize}

1564

1562

\end{itemize}

1565

1563

\begin{itemize}

1566

1564

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1567

1565

\itemsep1pt\parskip0pt\parsep0pt

GITLAB

110swag / docs

Made changes to F2