Mobile app for providing basic mathematics formulas for high school students

FPT University – Capstone Summer 2018 MINISTRY OF EDUCATION AND TRAINING FPT UNIVERSITY Capstone Project Document Mobile App for providing basic mathematics formulas for high school students GROUP 11 Group members Nguyễn Hồng Anh (Leader) - SE62165 Đơn Huỳnh Minh Đức - SE61568 Dương Gia Hòa - SE61973 Đỗ Thiên Tứ - SE61817 Supervisor Nguyễn Thế Hoàng Ext Supervisor N/A Capstones Project Code MF - Ho Chi Minh City, September 12nd, 2018 - Math Formulas Page FPT University – Capstone Summer 2018 TABLE OF CONTENTS LIST OF TABLES Math Formulas Page FPT University – Capstone Summer 2018 LIST OF FIGURES Definitions, Acronyms, and Abbreviations 12 A Introduction 14 Project Information 14 Introduction 14 Current Situation 15 Problem Definition 15 Proposed Solution 15 B 5.1 Feature functions 15 5.2 Advantages and disadvantages 16 Functional requirements 17 6.1 Administrator’s components 17 6.2 User’s components 17 6.3 Handler’s components 17 Role and responsibility 17 Software Project Management Plan 18 C Problem Definition 18 1.1 Name of this Capstone project 18 1.2 Problem Abstract 18 1.3 Project Overview 18 Project Organization 21 2.1 Software Process Model 21 2.2 Roles and responsibilities 22 2.3 Tools and Techniques 23 Project Management Plan 24 3.1 Project phases 24 3.2 Product backlog 26 3.3 All Meeting Minutes 28 Coding convention 28 Software Requirement Specification 29 User Requirement Specification 29 1.1 Math Formulas User Requirement 29 Page FPT University – Capstone Summer 2018 D 1.2 Admin Requirement 29 1.3 Handler Requirement 30 System Requirement Specification 30 2.1 External Interface Requirement 30 2.2 System Overview Use case 31 2.3 List of Use cases 32 Software System Attribute 96 3.1 Usability 96 3.2 Reliability 96 3.3 Availability 96 3.4 Security 97 3.5 Maintainability 97 3.6 Portability 97 3.7 Performance 97 Conceptual Diagram 99 Software Design Description 103 Design Overview .103 System Architectural Design 103 2.1 Web Application Architecture Description 105 2.2 Mobile Application Architecture Description .105 Component Diagram 106 Detail Description 108 4.1 Class Diagram 108 4.2 Class Diagram Explanation 109 Interaction Diagram .114 5.1 Web Application .114 5.2 Mobile Application 129 Interface 139 6.1 Admin Interface Design .139 6.2 User Interface Design .151 Database Design 165 7.1 Math Formulas Entity relationship diagram (ERD) 165 Page FPT University – Capstone Summer 2018 E Algorithms 173 8.1 Update version algorithm 173 8.2 Do quiz algorithm 175 System Implementation & Test 178 F Introduction 178 1.1 Overview .178 1.2 Test approach 178 Database Relationship Diagram 178 2.1 Physical model 178 2.2 Data dictionary 181 Technology, framework .184 3.1 Website 184 3.2 Mobile Application 184 Test plan .184 4.1 Features to be tested 184 4.2 Features not to be tested 185 System Testing Test Case .185 5.1 Communication Diagram 185 5.2 Test Case .191 Software User’s Manual 199 G Installation Guide 199 1.1 Setting up environment at server side 199 1.2 Deployment at server side 199 User Guide 201 2.1 Web Application .201 2.2 Mobile Application 232 Appendix 244 Spring 244 UML 244 SwipeRevelLayout 244 LIST OF TABLES Table 1: Roles and Responsibility 17 Math Formulas Page FPT University – Capstone Summer 2018 Table 2: Hardware Requirements for Server 20 Table 3: Hardware Requirement for Mobile 20 Table 4: Software Requirements 20 Table 5: Roles and Responsibility 23 Table 6: Tools 23 Table 7: Techniques 24 Table 8: Product phases 26 Table 9: Product backlog 28 Table 10: Get lesson detail Use Case Specification 34 Table 11: Get practice exercise Use Case Specification 36 Table 12: Get solutions Use Case Specification 38 Table 13: Search lesson Use Case Specification 40 Table 14: Add favorite lesson Use Case Specification 42 Table 15: Remove favorite lesson Use Case Specification 43 Table 16: Add note Use Case Specification 45 Table 17: Edit note Use Case Specification 48 Table 18: Delete note Use Case Specification 49 Table 19: Do quiz Use Case Specification 51 Table 20: Get chapter list Use Case Specification 52 Table 21: Reset chapter progress Use Case Specification 54 Table 22: Reset unfinished quiz Use Case Specification 56 Table 23: Select grade User Specification 58 Table 24: Add chapter Use Case Specification 62 Table 25: Edit chapter Use Case Specification 64 Table 26: Delete chapter Use Case Specification 66 Table 27: Add lesson Use Case Specification 68 Table 28: Edit lesson Use Case Specification 71 Table 29: Delete lesson Use Case Specification 72 Table 30: Add solution Use Case Specification 74 Table 31: Edit solution Use Case Specification 76 Table 32: Delete solution Use Case Specification 79 Table 33: Add Exercise Use Case Specification 80 Table 34: Edit Exercise Use Case Specification 82 Table 35: Delete Exercise Use Case Specification 84 Table 36: Add Quiz Question Use Case Specification 86 Table 37: Edit Quiz Question Use Case Specification 89 Table 38: Delete Quiz Question Use Case Specification 90 Table 39: Release new version Use Case Specification 92 Table 40: Check version Use Case Specification 96 Table 41: Web Application Conceptual Entity Data Dictionary 100 Table 42: Mobile Application Conceptual Entity Data Dictionary 102 Table 43: Math Formulas Component Diagram Dictionary 107 Math Formulas Page FPT University – Capstone Summer 2018 Table 44: Class Diagram Dictionary .109 Table 45: QuestionChoice attribute .109 Table 46: Question attribute .110 Table 47: Lesson attribute 110 Table 48: Chapter attribute .111 Table 49: Subject attribute 111 Table 50: Grade attribute 111 Table 51: Solution attribute 112 Table 52: Exercise attribute 112 Table 53: Version attribute .113 Table 54: User attribute 113 Table 55: DeleteQuery attribute 114 Table 56: Admin login - Field, Buttons, Hyperlinks 139 Table 57: Admin Manage Chapter - Field, Buttons, Hyperlinks 141 Table 58: Admin Manage Lesson - Field, Buttons, Hyperlinks 142 Table 59: Admin Add Lesson - Field, Buttons, Hyperlinks 143 Table 60: Admin Manage Solution - Field, Buttons, Hyperlinks 143 Table 61: Admin Manage Detail Solution - Field, Buttons, Hyperlinks 144 Table 62: Admin New Exercise - Field, Buttons, Hyperlinks 145 Table 63: Admin Manage Quizzes - Field, Buttons, Hyperlinks 147 Table 64: Admin Quiz Detail - Field, Buttons, Hyperlinks .147 Table 65: Admin New Quiz Question - Field, Buttons, Hyperlinks 148 Table 66: Admin Manage Versions - Field, Buttons, Hyperlinks .149 Table 67: Admin New Upgrade Version - Field, Buttons, Hyperlinks .150 Table 68: Check version - Field, Buttons, Hyperlinks .151 Table 69: Grade - Field, Buttons, Hyperlinks 152 Table 70: Chapter - Field, Buttons, Hyperlinks 155 Table 71: Update User Information - Field, Buttons, Hyperlinks .160 Table 72: Withdraw/Deposit - Field, Buttons, Hyperlinks 161 Table 73: Favorite - Field, Buttons, Hyperlinks 165 Table 74: Web Application Data dictionary 169 Table 75: Mobile Application Data dictionary 172 Table 76: Data dictionary 181 Table 77: Physical model Data dictionary 184 Table 78: Test case Create Object 192 Table 79: Test case Delete Object 194 Table 80: Test case Update Object 195 Table 81: Test case Home Screen 197 Table 82: Test case Search Screen 197 Table 83: Test case Quiz Screen 198 Table 84: Test case User’s Note Screen 199 Table 85: User Guide - Login .202 Math Formulas Page FPT University – Capstone Summer 2018 Table 86: User Guide – Create Chapter 203 Table 87: User Guide – Delete Chapter 204 Table 88: User Guide – Edit Chapter 205 Table 89: User Guide – Search Chapter 207 Table 90: User Guide – Create Lesson 208 Table 91: User Guide – Delete Lesson 210 Table 92: User Guide – Edit Lesson 211 Table 93: User Guide – Search Lesson 213 Table 94: User Guide – Create Solution 214 Table 95: User Guide – Edit Solution .216 Table 96: User Guide – Delete Solution 217 Table 97: User Guide – Create Exercise 219 Table 98: User Guide – Edit Exercise .221 Table 99: User Guide – Delete Exercise 222 Table 100: User Guide – Create Quiz Question 225 Table 101: User Guide – Edit Quiz Question .227 Table 102: User Guide – Delete Quiz Question 228 Table 103: User Guide – Search Quiz .230 Table 104: User Guide – Upgrade Version 231 Table 105: User Guide – View Formulas 233 Table 106: User Guide – Do Quiz .234 Table 107: User Guide – Search Formulas 235 Table 108: User Guide – Add Favorite Formulas 236 Table 109: User Guide – View Favorite Formulas 239 Table 110: User Guide – Delete Favorite Formulas 241 Table 111: User Guide – Add New User’s Note 242 Table 112: User Guide – Delete User’s Note .243 LIST OF FIGURES Figure 1: Scrum Model 21 Figure 2: System overview Use Case Diagram 31 Math Formulas Page FPT University – Capstone Summer 2018 Figure 3: User overview Use Case Diagram 32 Figure 4: Get lesson detail Use Case Diagram 33 Figure 5: Get practice exercise Use Case Diagram 35 Figure 6: Get solutions Use Case Diagram 37 Figure 7: Search lesson Use Case Diagram 39 Figure 8: Add favorite lesson Use Case Diagram 41 Figure 9: Remove favorite lesson Use Case Diagram 42 Figure 10: Add note Use Case Diagram 44 Figure 11: Edit note Use Case Diagram 46 Figure 12: Delete note Use Case Diagram 48 Figure 13: Do quiz Use Case Diagram 49 Figure 14: Get chapter list Use Case Diagram 51 Figure 15: Reset chapter progress Use Case Diagram 53 Figure 16: Reset unfinished quiz Use Case Diagram 55 Figure 17: Select grade Use Case Diagram 57 Figure 18: Administrator Overview Use Case 59 Figure 19: Add chapter Use Case Diagram 60 Figure 20: Edit chapter Use Case Diagram 62 Figure 21: Delete chapter Use Case Diagram 65 Figure 22: Add lesson Use Case Diagram 67 Figure 23: Edit lesson Use Case Diagram 69 Figure 24: Delete lesson Use Case Diagram 71 Figure 25: Add solution Use Case Diagram 73 Figure 26: Edit solution Use Case Diagram 75 Figure 27: Delete solution Use Case Diagram 77 Figure 28: Add Exercise Use Case Diagram 79 Figure 29: Edit Exercise Use Case Diagram 81 Figure 30: Delete Exercise Use Case Diagram 83 Figure 31: Add Quiz Question Use Case Diagram 85 Figure 32: Edit Quiz Question Use Case Diagram 87 Figure 33: Delete Quiz Question Use Case Diagram 89 Figure 34: Release new version Use Case Diagram 91 Figure 35: Overview Use case 93 Figure 36: Check version Use Case Diagram 94 Figure 37: Web application Conceptual diagram 99 Figure 38: Mobile Application Conceptual Diagram 101 Figure 39: System Architectural Diagram 104 Figure 40: Math Formulas Component Diagram 106 Figure 41: Web Application Class Diagram 108 Figure 42: Login Sequence Diagram 114 Figure 43: Add new chapter Sequence Diagram .115 Figure 44: Update chapter Sequence Diagram 116 Math Formulas Page FPT University – Capstone Summer 2018 Figure 45: Delete chapter Sequence Diagram 117 Figure 46: Add new lesson Sequence Diagram 118 Figure 47: Update lesson Sequence Diagram .118 Figure 48: Delete lesson Sequence Diagram .119 Figure 49: Add new solution Sequence Diagram 120 Figure 50: Update solution Sequence Diagram 121 Figure 51: Delete solution Sequence Diagram 122 Figure 52: Add new exercise Sequence Diagram 123 Figure 53: Update Exercice Sequence Diagram 124 Figure 54: Delete exercise Sequence Diagram 125 Figure 55: Add new quiz question Sequence Diagram 126 Figure 56: Update quiz question Sequence Diagram 127 Figure 57: Delete quiz question Sequence Diagram 128 Figure 58: Release new version Sequence Diagram .128 Figure 59: Data loading progress Activity Diagram .129 Figure 60: Search lesson Activity Diagram 130 Figure 61: View lesson and solution detail 131 Figure 62: Add favorite lesson Activity Diagram 132 Figure 63: Remove favorite lesson Activity Diagram 133 Figure 64: Add user’s note Activity Diagram 134 Figure 65: Edit user’s note Activity Diagram 135 Figure 66: Delete user’s note Activity Diagram 136 Figure 67: Choose grade Activity Diagram 137 Figure 68: Do quiz Activity Diagram 138 Figure 69: Login Interface 139 Figure 70: Manage User Interface .140 Figure 71: Manage Lesson Interface 141 Figure 72: Add Lesson Interface 142 Figure 73: Manage Solution 143 Figure 74: Manage Detail Solution 144 Figure 75: New Exercise 145 Figure 76: Manage Quizzes 146 Figure 77: Quiz Detail 147 Figure 78: New Quiz Question 148 Figure 79: Manage Versions 149 Figure 80: New Upgrade Version 150 Figure 81: Check Version Interface 151 Figure 82: Choose Grade Interface 152 Figure 83: Chapter Interface (1) 153 Figure 84: Search Interface (2) 154 Figure 85: Lesson Interface (1) 155 Figure 86: Lesson Interface (2) 156 Math Formulas Page 10 FPT University – Capstone Summer 2018 Step Description Go to “ Quiz” page Click on Search field Input keywords Press Enter Table 103: User Guide – Search Quiz 2.1.20 Upgrade Version Figure 144: User Guide – Upgrade Version (1) Math Formulas Page 230 FPT University – Capstone Summer 2018 Figure 145: User Guide – Upgrade Version (2) Step Description Go to “Version” page Click on “New version” button Input fields: - Version number: number of the new version upgrade - Version name: name of the new version upgrade Click on “Save” button Table 104: User Guide – Upgrade Version Math Formulas Page 231 FPT University – Capstone Summer 2018 2.2.Mobile Application 2.2.1 View formulas Figure 146: User Guide – View Formulas Step Description Go to “ Lớp” menu Choose a class Choose a subject Choose lesson Touch on lesson title to view formulas Math Formulas Page 232 FPT University – Capstone Summer 2018 Table 105: User Guide – View Formulas 2.2.2 Do quiz Figure 147: User Guide – Do Quiz Step Description Go to “Công Thức” menu View the formula you want to take Math Formulas Page 233 FPT University – Capstone Summer 2018 Touch on the quiz logo (on the top right of formula screen) Do the Quiz After finished, swipe to review answers Table 106: User Guide – Do Quiz 2.2.3 Search formula Figure 148: User Guide – Search Formulas Math Formulas Page 234 FPT University – Capstone Summer 2018 Step Description Go to “ Lớp” menu Touch on the search field on the top of the screen Input keyword into search bar Touch on search key on keyboard/or search icon on search bar/ or search suggestion Table 107: User Guide – Search Formulas 2.2.4 Add favorite formula Math Formulas Page 235 FPT University – Capstone Summer 2018 Figure 149: User Guide – Add Favorite Formulas Step Description Go to “ Lesson” menu Swipe the formula you want to add to favorite list to the left 3.1 Touch on the favorite icon (heart icon) 3.2 Touch on the favorite icon again to undo (heart icon) Table 108: User Guide – Add Favorite Formulas Math Formulas Page 236 FPT University – Capstone Summer 2018 2.2.5 View favorite formulas Figure 150: User Guide – View Favorite Formulas (1) Math Formulas Page 237 FPT University – Capstone Summer 2018 Figure 151: User Guide – View Favorite Formulas (2) Step Description Math Formulas Page 238 FPT University – Capstone Summer 2018 Go to “ Yêu Thích” menu Swipe left the formula you want to view Touch on the Eye icon Table 109: User Guide – View Favorite Formulas Math Formulas Page 239 FPT University – Capstone Summer 2018 2.2.6 Delete favorite formulas Figure 152: User Guide – Delete Favorite Formulas Math Formulas Page 240 FPT University – Capstone Summer 2018 Step Description Go to “ Yêu Thích” menu Swipe left the formula you want to delete Touch on the Delete icon Table 110: User Guide – Delete Favorite Formulas 2.2.7 Add new user’s note Figure 153:User Guide – Add New User’s Note Math Formulas Page 241 FPT University – Capstone Summer 2018 Step Description Go to “ Note” menu Touch on the + icon in the bottom right Input fields: - Title: Title of the note - Content: Content of the note, user can draw by touch the draw icon on the right Touch “Lưu” button to save note Table 111: User Guide – Add New User’s Note 2.2.8 Delete user’s note Math Formulas Page 242 FPT University – Capstone Summer 2018 Figure 154: User Guide – Delete User’s Note Step Description Go to “Note” menu Swipe left the note you want to delete Touch the “Delete” icon Pop up: “Đã xó a ‘Note’s Title’” Table 112: User Guide – Delete User’s Note Math Formulas Page 243 FPT University – Capstone Summer 2018 G.Appendix Spring https://docs.spring.io/spring/docs/current/spring-frameworkreference/web.html UML https://www.uml-diagrams.org/ SwipeRevelLayout https://github.com/chthai64/SwipeRevealLayout Math Formulas Page 244 ... English: Mobile App for providing basic mathematics formulas for high school students ● Vietnamese: Sổ tay cơng thức tốn học cho học sinh trung học phổ thông ● Abbreviation: MF (Math is Fun, Math Formulas) ... application that would make it easier for high school students to learn math than ever before No need to make paper notes to remember math formulas, students would use this app to store all formulas. .. Requirement Specification Math Formulas is an application which provides basic and advanced math formulas and related knowledge for high school students Users can easily get information they need based