-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.html
executable file
·1 lines (1 loc) · 10.1 KB
/
README.html
1
<html><head><title>CS108 Readme File</title><style type="text/css">ol{margin:0;padding:0}.c3{padding-left:0pt;direction:ltr;margin-left:36pt}.c1{list-style-type:disc;margin:0;padding:0}.c12{max-width:468pt;background-color:#ffffff;padding:72pt 72pt 72pt 72pt}.c9{list-style-type:circle;margin:0;padding:0}.c0{padding-left:0pt;direction:ltr;margin-left:72pt}.c10{color:#1155cc;text-decoration:underline}.c13{font-size:18pt;text-decoration:underline}.c8{color:inherit;text-decoration:inherit}.c2{font-size:10pt}.c4{font-size:12pt}.c11{text-align:center}.c6{font-weight:bold}.c5{direction:ltr}.c7{height:11pt}.title{padding-top:0pt;line-height:1.15;text-align:left;color:#000000;font-size:21pt;font-family:"Trebuchet MS";padding-bottom:0pt}.subtitle{padding-top:0pt;line-height:1.15;text-align:left;color:#666666;font-style:italic;font-size:13pt;font-family:"Trebuchet MS";padding-bottom:10pt}li{color:#000000;font-size:11pt;font-family:"Arial"}p{color:#000000;font-size:11pt;margin:0;font-family:"Arial"}h1{padding-top:10pt;line-height:1.15;text-align:left;color:#000000;font-size:16pt;font-family:"Trebuchet MS";padding-bottom:0pt}h2{padding-top:10pt;line-height:1.15;text-align:left;color:#000000;font-size:13pt;font-family:"Trebuchet MS";font-weight:bold;padding-bottom:0pt}h3{padding-top:8pt;line-height:1.15;text-align:left;color:#666666;font-size:12pt;font-family:"Trebuchet MS";font-weight:bold;padding-bottom:0pt}h4{padding-top:8pt;line-height:1.15;text-align:left;color:#666666;font-size:11pt;text-decoration:underline;font-family:"Trebuchet MS";padding-bottom:0pt}h5{padding-top:8pt;line-height:1.15;text-align:left;color:#666666;font-size:11pt;font-family:"Trebuchet MS";padding-bottom:0pt}h6{padding-top:8pt;line-height:1.15;text-align:left;color:#666666;font-style:italic;font-size:11pt;font-family:"Trebuchet MS";padding-bottom:0pt}</style></head><body class="c12"><p class="c5 c11"><span class="c6 c13">CS108 Final Project README</span></p><p class="c5 c7"><span class="c4"></span></p><p class="c5"><span class="c4 c6">Team Members:</span></p><p class="c5 c7"><span class="c2"></span></p><p class="c5"><span class="c2">Angela Yeung <</span><span class="c10 c2"><a class="c8" href="mailto:[email protected]">[email protected]</a></span><span class="c2">></span></p><p class="c5"><span class="c2">Frank Chen <</span><span class="c2 c10"><a class="c8" href="mailto:[email protected]">[email protected]</a></span><span class="c2">></span></p><p class="c5"><span class="c2">Jessica Liu <</span><span class="c10 c2"><a class="c8" href="mailto:[email protected]">[email protected]</a></span><span class="c2">></span></p><p class="c5 c7"><span class="c4"></span></p><p class="c5"><span class="c4 c6">Installation Instructions</span></p><p class="c5 c7"><span class="c4"></span></p><p class="c5"><span class="c2">The database schema is in the submission folder as </span><span class="c2 c6">schema.sql</span><span class="c2">. Load the schema into an appropriate MySQL database and change the relevant authentication information in src/quiz/base/DBConnector.java and the project should be runnable. </span></p><p class="c5 c7"><span class="c2"></span></p><p class="c5"><span class="c2">There is a default account <</span><span class="c10 c2"><a class="c8" href="mailto:[email protected]">[email protected]</a></span><span class="c2">, </span><span class="c2">frank> (as administrator). We have populated the quiz system with some sample quizzes for demonstration purposes.</span></p><p class="c5 c7"><span class="c4 c6"></span></p><p class="c5"><span class="c4 c6">Extra Features Completed</span></p><p class="c5 c7"><span class="c2"></span></p><p class="c5"><span class="c2">We have implemented all required features for a three person team. Picture-Response questions and Question-Response questions are merged into a Question/Picture response type.</span></p><p class="c5 c7"><span class="c2"></span></p><p class="c5"><span class="c2">In addition, we have completed the following recommended and optional features:</span></p><p class="c5 c7"><span class="c2"></span></p><ol class="c1" start="1"><li class="c3"><span class="c2">Multi-Answer Questions</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can specify multiple allowable answers, each with different point values. For instance, answering Kennedy may earn 5 points while answering John F. Kennedy may earn 10 points.</span></li></ol><ol class="c1" start="2"><li class="c3"><span class="c2">Multiple Fill-in-the-Blanks Question</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can have multiple blanks (specified by [1], [2], etc...) within the same question. They can again specify multiple answers per blank with differing point values</span></li></ol><ol class="c1" start="3"><li class="c3"><span class="c2">Multiple Choice with Multiple Answer Questions</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Multiple choice questions have two option groups. Quiz creators can create quizzes with 5 correct options and 10 wrong options and specify that 2 correct options and 5 wrong options appear on any given attempt. </span></li><li class="c0"><span class="c2">Creators can also specify different point values for each of the correct and wrong answers, including negative point values, if desired. </span></li><li class="c0"><span class="c2">Creators can specify whether users should only be allowed one choice or multiple choices.</span></li></ol><ol class="c1" start="4"><li class="c3"><span class="c2">Quiz Editing</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Creators can edit a quiz after creating it. In fact, quiz creators can edit a quiz and not have it disrupt users who are currently taking the quiz or the displaying of quiz histories as initializing a new attempt will “freeze” the state of the quiz for that particular attempt.</span></li></ol><ol class="c1" start="5"><li class="c3"><span class="c2">Save and Resume</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can save their current answers in a quiz and resume at a later date.</span></li></ol><ol class="c1" start="6"><li class="c3"><span class="c2">Quiz History</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can view their own quiz histories, including scores and time completed. A complete user history is also visible on the user’s profile page.</span></li><li class="c0"><span class="c2">In addition, users can look at what they have answered for every single attempt in the quiz.</span></li></ol><ol class="c1" start="7"><li class="c3"><span class="c2">Passwords are salted with emails of the users</span></li><li class="c3"><span class="c2">Administration Interfaces</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Administrators can edit, delete, and clear the histories of other users’ quizzes</span></li><li class="c0"><span class="c2">Administrators can create and delete announcements</span></li><li class="c0"><span class="c2">Administrators can view statistics about website activity: number of users, quizzes, challenges currently outstanding, quizzes taken, friendships made, friend requests outstanding, messages, and outstanding challenges.</span></li><li class="c0"><span class="c2">Administrators can promote and demote other users/admins from Administrator status</span></li></ol><ol class="c1" start="9"><li class="c3"><span class="c2">Website Look</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">The website is generally well-designed and styled in CSS3. The navigational elements are consistent across all our webpages using a hand-built templating system.</span></li></ol><ol class="c1" start="10"><li class="c3"><span class="c2">Prepared Statements</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">We used prepared statements for all user input so that typing in ‘ or “ within our system will not cause SQL errors or other problems.</span></li></ol><ol class="c1" start="11"><li class="c3"><span class="c2">Non-Registered Access</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users who are not registered can access some parts of the website (e.g. announcements) without registration.</span></li></ol><ol class="c1" start="12"><li class="c3"><span class="c2">Cookies</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can elect to save their session into a cookie. The website will automatically detect the presence of a cookie and logs it in. The cookie string is completely opaque to the user and securely generated.</span></li></ol><ol class="c1" start="13"><li class="c3"><span class="c2">Achievements</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users receive achievements for various actions, specifically the six mentioned in the handout. Whenever an achievement is unlocked, it is displayed on the user’s home and profile page.</span></li></ol><ol class="c1" start="14"><li class="c3"><span class="c2">Statistics</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can view most recently created quizzes, most popular quizzes, as well as up-to-date information about their friends’ activities and top scores for quizzes.</span></li></ol><ol class="c1" start="15"><li class="c3"><span class="c2">Tags</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Quiz creators can add tags to their quizzes at any time. A list of popular tags are provided for users to select, but users can also create new hashtags that will be added to the database. Quizzes can then be searched by tag. A tag cloud visualizing the popularity of tags also provides another interface by which to explore quizzes.</span></li></ol><ol class="c1" start="16"><li class="c3"><span class="c2">Ratings and Reviews</span></li></ol><ol class="c9" start="1"><li class="c0"><span class="c2">Users can rate quizzes on a five-star system after taking a quiz. They can also write a review for the quiz if they wish.</span></li></ol><p class="c5 c7"><span class="c2"></span></p></body></html>