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

\item[Primary Actor]{Instructor}

588

\item[Primary Actor]{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]{None.}

701

\item[Pre-conditions]{None.}

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 corner of the navigation bar.}

713

{The User shall click the '?' button in the right corner of the navigation bar.}

\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 shall generate a POST request consisting of the flashcard text,

787

\item {The frontend shall generate a POST request consisting of the flashcard text,

blanks, and material date, in JSON form in FeedController.js and send it to /api/flashcards/.}

788

blanks, and material date, in JSON form in FeedController.js and send it to /api/flashcards/.}

\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 duplicate the flashcard authored by a different user and make changes to it.}

806

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

807

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

808

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

\\

809

\\

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

810

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

811

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

812

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

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

813

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

Flashcard}

814

Flashcard}

815

\item[Pre-conditions]

816

\item[Pre-conditions]

817

\begin{itemize}

818

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

819

\itemsep1pt\parskip0pt\parsep0pt

\item

820

\item

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

821

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

\item

822

\item

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

823

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

\end{itemize}

824

\end{itemize}

825

\item[Post-conditions]

826

\item[Post-conditions]

827

\begin{itemize}

828

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

829

\itemsep1pt\parskip0pt\parsep0pt

\item

830

\item

{A duplicate flashcard with some differences is created.}

831

{A duplicate flashcard with some differences is created.}

\end{itemize}

832

\end{itemize}

833

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

834

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

\item[Workflow]

835

\item[Workflow]

836

\begin{enumerate}

837

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

838

\itemsep1pt\parskip0pt\parsep0pt

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

839

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

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

840

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

\item

841

\item

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

842

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

text }

843

text }

\item

844

\item

{The user shall make desired changes}

845

{The user shall make desired changes}

\item

846

\item

{The user shall click `Save Changes'}

847

{The user shall click `Save Changes'}

\item

848

\item

{The client shall generate a PATCH request for a new flashcard in CardGridController.js

849

{The client shall generate a PATCH request for a new flashcard in CardGridController.js

and send it to the server at /api/flashcards/}

850

and send it to the server at /api/flashcards/}

\item

851

\item

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

852

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

create a new FlashcardMask object and update the appropriate

853

create a new FlashcardMask object and update the appropriate

UserFlashcard object with a reference to it.}

854

UserFlashcard object with a reference to it.}

\item

855

\item

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

856

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

857

\begin{enumerate}

858

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

859

\itemsep1pt\parskip0pt\parsep0pt

\item

860

\item

{Create a new flashcard for the section}

861

{Create a new flashcard for the section}

\item

862

\item

{Push it to the feed}

863

{Push it to the feed}

\item

864

\item

{Add it to the user's deck}

865

{Add it to the user's deck}

\item

866

\item

{Hide the old card from the user}

867

{Hide the old card from the user}

\item

868

\item

{Return the new card to the user}

869

{Return the new card to the user}

\end{enumerate}

870

\end{enumerate}

871

\end{enumerate}

\end{description}

872

\end{description}

{}

873

{}

874

\newpage

875

\newpage

876

{}

877

{}

878

\subsection{[F3] Pull Flashcard}

879

\subsection{[F3] Pull Flashcard}

\begin{description}

880

\begin{description}

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

881

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

deck from the Live Feed. }

882

deck from the Live Feed. }

883

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

884

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

deck }

885

deck }

\\

886

\\

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

887

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

888

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

889

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

890

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

891

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

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

892

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

\\

893

\\

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

894

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

895

\item[Status]{Implemented}

896

\item[Status]{Implemented}

897

\item[Pre-conditions]

898

\item[Pre-conditions]

899

\begin{itemize}

900

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

901

\itemsep1pt\parskip0pt\parsep0pt

\item

902

\item

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

903

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

\item

904

\item

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

905

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

\end{itemize}

906

\end{itemize}

907

\item[Post-conditions]

908

\item[Post-conditions]

909

\begin{itemize}

910

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

911

\itemsep1pt\parskip0pt\parsep0pt

\item

912

\item

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

913

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

\item

914

\item

{User can review this flashcard later.}

915

{User can review this flashcard later.}

\end{itemize}

916

\end{itemize}

917

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

918

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

919

\item[Workflow]

920

\item[Workflow]

921

\begin{enumerate}

922

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

923

\itemsep1pt\parskip0pt\parsep0pt

\item

924

\item

{The user shall hover over the flashcard he wants to add to his deck and click on the '+'

925

{The user shall hover over the flashcard he wants to add to his deck and click on the '+'

icon that appears in the center of the card.}

926

icon that appears in the center of the card.}

\item

927

\item

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

928

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

\item

929

\item

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

930

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

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

931

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

\item

932

\item

{The server shall call the FlashcardViewSet.pull to handle the POST request sent by the frontend.}

933

{The server shall call the FlashcardViewSet.pull to handle the POST request sent by the frontend.}

\item

934

\item

{The FlashcardViewSet.pull method should call the user.pull method in models.py with the flashcard object

935

{The FlashcardViewSet.pull method should call the user.pull method in models.py with the flashcard object

to be pulled as an argument}

936

to be pulled as an argument}

\item

937

\item

{The user.pull method shall create a UserFlashcard object associated with the request's user and the

938

{The user.pull method shall create a UserFlashcard object associated with the request's user and the

passed in flashcard object and save it in the database.}

939

passed in flashcard object and save it in the database.}

\item

940

\item

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

941

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

if any}

942

if any}

\item

943

\item

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

944

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

rearranging the feed.}

945

rearranging the feed.}

\end{enumerate}

946

\end{enumerate}

\end{description}

947

\end{description}

\newpage

948

\newpage

949

{}

950

{}

951

\subsection{[F4] Flag Inappropriate Cards}

952

\subsection{[F4] Flag Inappropriate Cards}

953

\begin{description}

954

\begin{description}

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

955

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

956

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

957

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

adjusted.}

958

adjusted.}

\\

959

\\

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

960

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

should not be displayed in the feed.}

961

should not be displayed in the feed.}

962

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

963

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

964

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

965

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

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

966

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

\\

967

\\

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

968

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

969

\item[Status]{Implemented}

970

\item[Status]{Implemented}

971

\item[Pre-conditions]

972

\item[Pre-conditions]

973

\begin{itemize}

974

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

975

\itemsep1pt\parskip0pt\parsep0pt

\item

976

\item

{The user is enrolled in a class}

977

{The user is enrolled in a class}

\item

978

\item

{The flashcard has been created.}

979

{The flashcard has been created.}

\item

980

\item

{The flashcard is viewable in feed.}

981

{The flashcard is viewable in feed.}

\item

982

\item

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

983

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

\end{itemize}

984

\end{itemize}

985

\item[Post-conditions]

986

\item[Post-conditions]

987

\begin{itemize}

988

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

989

\itemsep1pt\parskip0pt\parsep0pt

\item

990

\item

{Flashcard is hidden from user.}

991

{Flashcard is hidden from user.}

\item

992

\item

{The flashcard is marked as being inappropriate.}

993

{The flashcard is marked as being inappropriate.}

\end{itemize}

994

\end{itemize}

995

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

996

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

997

\item[Workflow]

998

\item[Workflow]

999

\begin{enumerate}

1000

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1001

\itemsep1pt\parskip0pt\parsep0pt

\item

1002

\item

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

1003

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

\item

1004

\item

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

1005

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

\item

1006

\item

{The frontend shall hide the flashcard from the user in FlashcardFactory.js.}

1007

{The frontend shall hide the flashcard from the user in FlashcardFactory.js.}

\item

1008

\item

{The frontend shall generate a POST request in Flashcard.report in FlashcardFactory.js

1009

{The frontend shall generate a POST request in Flashcard.report in FlashcardFactory.js

and send it to /api/flashcards/\textless{}flashcard id \textgreater{}/report}

1010

and send it to /api/flashcards/\textless{}flashcard id \textgreater{}/report}

\item

1011

\item

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

1012

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

\item

1013

\item

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

1014

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

\end{enumerate}

1015

\end{enumerate}

\end{description}

1016

\end{description}

{}

1017

{}

1018

{}

1019

{}

1020

\newpage

1021

\newpage

1022

{}

1023

{}

1024

\subsection{[F5] Filter Flashcards }

1025

\subsection{[F5] Filter Flashcards }

1026

\begin{description}

1027

\begin{description}

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

1028

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

1029

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

1030

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

options: the material date and the text of the card.}

1031

options: the material date and the text of the card.}

1032

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

1033

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

for.}

1034

for.}

1035

\item[Primary Actor]{User}

1036

\item[Primary Actor]{User}

1037

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

1038

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

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

1039

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

Flashcard}

1040

Flashcard}

\\

1041

\\

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

1042

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

1043

\item[Status]{Implemented }

1044

\item[Status]{Implemented }

1045

\item[Pre-conditions]

1046

\item[Pre-conditions]

1047

\begin{itemize}

1048

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1049

\itemsep1pt\parskip0pt\parsep0pt

\item

1050

\item

{The user has added a class.}

1051

{The user has added a class.}

\item

1052

\item

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

1053

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

\end{itemize}

1054

\end{itemize}

1055

\item[Post-conditions]{}

1056

\item[Post-conditions]{}

1057

\begin{itemize}

1058

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1059

\itemsep1pt\parskip0pt\parsep0pt

\item

1060

\item

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

1061

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

\end{itemize}

1062

\end{itemize}

1063

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

1064

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

1065

\item[Workflow]

1066

\item[Workflow]

1067

\begin{enumerate}

1068

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1069

\itemsep1pt\parskip0pt\parsep0pt

\item

1070

\item

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

1071

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

\item

1072

\item

{The user shall select the weeks that the filtered cards should belong to.}

1073

{The user shall select the weeks that the filtered cards should belong to.}

\item

1074

\item

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

1075

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

\item

1076

\item

{The frontend generates a POST request with the flashcard dates and the flashcard text filter as

1077

{The frontend generates a POST request with the flashcard dates and the flashcard text filter as

parameteres and sends it to /api/study.}

1078

parameteres and sends it to /api/study.}

\item

1079

\item

{The system displays only the cards that match the filter criteria specified by the user.}

1080

{The system displays only the cards that match the filter criteria specified by the user.}

1081

\end{enumerate}

1082

\end{enumerate}

\end{description}

1083

\end{description}

{}

1084

{}

1085

\newpage

1086

\newpage

1087

{}

1088

{}

1089

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

1090

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

1091

\begin{description}

1092

\begin{description}

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

1093

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

flashcard in his deck. }

1094

flashcard in his deck. }

1095

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

1096

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

System that they are keywords. }

1097

System that they are keywords. }

\\

1098

\\

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

1099

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

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

1100

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

User guess what they are.}

1101

User guess what they are.}

1102

{Primary Actor: }{User (student)}

1103

{Primary Actor: }{User (student)}

1104

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

1105

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

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

1106

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

\\

1107

\\

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

1108

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

1109

\item[Status]{Implemented.}

1110

\item[Status]{Implemented.}

1111

\item[Pre-conditions]

1112

\item[Pre-conditions]

1113

\begin{itemize}

1114

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1115

\itemsep1pt\parskip0pt\parsep0pt

\item

1116

\item

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

1117

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

\item

1118

\item

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

1119

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

\item

1120

\item

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

1121

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

\item

1122

\item

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

1123

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

\end{itemize}

1124

\end{itemize}

1125

{Post-conditions: }

1126

{Post-conditions: }

1127

\begin{itemize}

1128

\begin{itemize}

\itemsep1pt\parskip0pt\parsep0pt

1129

\itemsep1pt\parskip0pt\parsep0pt

\item

1130

\item

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

1131

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

\item

1132

\item

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

1133

{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

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

\end{itemize}

1135

\end{itemize}

1136

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

1137

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

1138

\item[Workflow]

1139

\item[Workflow]

1140

\begin{enumerate}

1141

\begin{enumerate}

\itemsep1pt\parskip0pt\parsep0pt

1142

\itemsep1pt\parskip0pt\parsep0pt

\item

1143

\item

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

1144

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

\item

1145

\item

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

1146

{The frontend shall enclose the selected text in \textless{}b\textgreater{} tags to alter its appearance.}

\item

1147

\item

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

1148

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

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

1149

\item

1150

{The frontend shall convert the blanked portion of the text into a list of offsets to be

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

1151

sent to the backend in FeedController.js.}

\item

1152

\item

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

1153

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

\end{enumerate}

1154

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

1155

\item

{Alternative Workflows:}

1156

{The backend shall save the new mask in models.py.}

1157

\end{enumerate}

\begin{enumerate}

1158

\itemsep1pt\parskip0pt\parsep0pt

1159

{Alternative Workflows:}

\item

1160

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

1161

\begin{enumerate}

\item

1162

\itemsep1pt\parskip0pt\parsep0pt

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

1163

\item

1164

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

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

1165

\item

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

1166

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

\item

1167

\item

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

1168

{The frontend shall enclose the selected text in \textless{}b\textgreater{} tags to alter its appearance.}

\item

1169

\item

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

1170

{The frontend shall convert the blanked portion of the text into a list of offsets to be

1171

sent to the backend in CardGridController.js.}

\end{enumerate}

1172

\item

\end{description}

1173

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

{}

1174

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

1175

\item

\newpage

1176

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

1177

\end{enumerate}

{}

1178

\end{description}

1179

{}

\subsection{[F7] Fix Flashcard}

1180

1181

\newpage

\begin{description}

1182

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

1183

{}

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

1184

1185

\subsection{[F7] Fix Flashcard}

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

1186

alteration will be shown to all users of that flashcard}

1187

\begin{description}

\\

1188

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

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

1189

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

than it did originally.}

1190

1191

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

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

1192

alteration will be shown to all users of that flashcard}

1193

\\

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

1194

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

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

1195

than it did originally.}

\\

1196

\item[Priority Level]{Must}

1197

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

1198

\item[Status]{Implemented}

1199

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

1200

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

\item[Pre-conditions]

1201

\\

1202

\item[Priority Level]{Must}

\begin{itemize}

1203

\itemsep1pt\parskip0pt\parsep0pt

1204

\item[Status]{Implemented}

\item

1205

{User has created the flashcard}

1206

\item[Pre-conditions]

\end{itemize}

1207

1208

\begin{itemize}

\item[Post-conditions]{}

1209

\itemsep1pt\parskip0pt\parsep0pt

1210

\item

\begin{itemize}

1211

{User has created the flashcard}

\itemsep1pt\parskip0pt\parsep0pt

1212

\end{itemize}

\item

1213

{The user shall see their alteration for that flashcard}

1214

\item[Post-conditions]{}

\item

1215

{Other users will be notified of the alteration}

1216

\begin{itemize}

\end{itemize}

1217

\itemsep1pt\parskip0pt\parsep0pt

1218

\item

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

1219

{The user shall see their alteration for that flashcard}

``Edit''}

1220

\item

1221

{Other users will be notified of the alteration}

\item[Workflow]

1222

\end{itemize}

1223

\begin{enumerate}

1224

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

\itemsep1pt\parskip0pt\parsep0pt

1225

``Edit''}

\item

1226

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

1227

\item[Workflow]

\item

1228

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

1229

\begin{enumerate}

\item

1230

\itemsep1pt\parskip0pt\parsep0pt

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

1231

\item

1232

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

{The Flashcard will display editable fields/areas.}

1233

\item

1234

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

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

1235

\item

1236

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

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

1237

\item

1238

{The Flashcard will display editable fields/areas.}

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

1239

\item

1240

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

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

1241

\item

1242

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

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

1243

\item

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

1244

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

changes.}

1245

\item

\end{enumerate}

1246

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

\end{description}

1247

\item

{}

1248

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

1249

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

{}

1250

changes.}

1251

\end{enumerate}

{}

1252

\end{description}

1253

{}

\newpage

1254

1255

{}

1256

1257

{}

\subsection{[F8] Hide Cards}

1258

1259

\newpage

\begin{description}

1260

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

1261

{}

1262

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

1263

\subsection{[F8] Hide Cards}

\\

1264

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

1265

\begin{description}

reduce screen clutter}

1266

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

1267

{Primary Actor: }{User (Student)}

1268

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

1269

\\

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

1270

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

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

1271

reduce screen clutter}

\\

1272

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

1273

{Primary Actor: }{User (Student)}

1274

{Status:}{Implemented}

1275

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

1276

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

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

1277

\\

1278

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

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

1279

1280

{Status:}{Implemented}

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

1281

1282

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

\item[Workflow]

1283

1284

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

\begin{enumerate}

1285

\itemsep1pt\parskip0pt\parsep0pt

1286

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

\item

1287

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

1288

\item[Workflow]

\item

1289

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

1290

\begin{enumerate}

\item

1291

\itemsep1pt\parskip0pt\parsep0pt

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

1292

\item

1293

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

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

1294

\item

hidden.}

1295

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

\item

1296

\item

{The frontend shall make a request to the backend from FeedController.js.}

1297

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

\item

1298

\item

{The backend shall check if the User has already hidden that card in views.py.}

1299

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

\item

1300

hidden.}

{The backend shall change the falshcard to hidden in the models.py.}

1301

\item

1302

{The frontend shall make a request to the backend from FeedController.js.}

{The frontend shall no longer show that card when the feed is rendered.}

1303

\item

\end{enumerate}

1304

{The backend shall check if the User has already hidden that card in views.py.}

1305

\item

\end{description}

1306

{The backend shall change the falshcard to hidden in the models.py.}

1307

\item

\newpage

1308

{The frontend shall no longer show that card when the feed is rendered.}

1309

\end{enumerate}

{}

1310

1311

\end{description}

\subsection{[F9] View a Feed}

1312

1313

\newpage

\begin{description}

1314

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

1315

{}

classes}

1316

1317

\subsection{[F9] View a Feed}

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

1318

specific classes. }

1319

\begin{description}

\\

1320

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

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

1321

classes}

1322

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

1323

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

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

1324

specific classes. }

\\

1325

\\

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

1326

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

1327

{Status:}{Implemented}

1328

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

1329

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

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

1330

\\

1331

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

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

1332

1333

{Status:}{Implemented}

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

1334

1335

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

\item[Workflow]

1336

1337

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

\begin{enumerate}

1338

\itemsep1pt\parskip0pt\parsep0pt

1339

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

\item

1340

{The User logs into their account.}

1341

\item[Workflow]

\item

1342

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

1343

\begin{enumerate}

\item

1344

\itemsep1pt\parskip0pt\parsep0pt

{The User is at their dashboard.}

1345

\item

1346

{The User logs into their account.}

{The Client shows the User's dashboard.}

1347

\item

1348

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

{The User selects a class from their dashboard.}

1349

\item

1350

{The User is at their dashboard.}

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

1351

\item

\end{enumerate}

1352

{The Client shows the User's dashboard.}

1353

\item

\end{description}

1354

{The User selects a class from their dashboard.}

\newpage

1355

\item

1356

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

{}

1357

\end{enumerate}

\section{Decks}

1358

1359

\end{description}

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

1360

\newpage

1361

\begin{description}

1362

{}

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

1363

\section{Decks}

1364

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

1365

\\

1366

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

1367

1368

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

1369

1370

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

1371

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

1372

\\

1373

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

1374

1375

\item[Status]{Implemented}

1376

1377

\item[Pre-conditions]

1378

1379

\begin{itemize}

1380

\itemsep1pt\parskip0pt\parsep0pt

1381

\item

1382

{The User has an account with the application}

1383

\item

1384

{The User is logged in}

1385

\end{itemize}

1386

1387

\item[Post-conditions]

1388

1389

\begin{itemize}

1390

\itemsep1pt\parskip0pt\parsep0pt

1391

\item

1392

{Desired cards are hidden to the user.}

1393

\end{itemize}

1394

1395

\item[Trigger]{The User no longer wishes to be able to study a card. }

1396

1397

\item[Workflow]

1398

1399

\begin{enumerate}

1400

\itemsep1pt\parskip0pt\parsep0pt

1401

\item

1402

{The Client shows the user the dashboard.}

1403

\item

1404

{The User shall select the appropriate class.}

1405

\item

1406

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

1407

\item

1408

{The User shall select deck view.}

1409

\item

1410

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

1411

\item

1412

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

1413

\item

1414

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

1415

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

1416

\item

1417

GITLAB

110swag / docs

Compare View

Diff