diff options
Diffstat (limited to 'docs/DesignDocument.md')
| -rw-r--r-- | docs/DesignDocument.md | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md index 6fb6b37..7d9bc14 100644 --- a/docs/DesignDocument.md +++ b/docs/DesignDocument.md @@ -9,36 +9,30 @@ Tomer Kimia Andrew Murell Luke Shumaker Davis Webb - -Contents - -Purpose 4 -Non-Functional Requirements 4 -Design Outlines 4 -Design Decisions and Components 4 -Component Interaction 4 -Each of these controllers will fetch the data specified by its separate section. The view will then be used to display all of this information, so Login will take the user to a login page, search will take the user to a search page and so on. 4 -Design Issues 4 -Scoring Algorithm 4 -Offline Data Management 5 -Fetching Data from Games 5 -Design Details 5 -Class Descriptions and Interactions 5 -UML Diagram of Classes 5 - - - +1. Contents +1Purpose 3 +2Non-Functional Requirements 3 +3Design Outlines 3 +3.1Design Decisions and Components 3 +3.2Component Interaction 3 +4Design Issues 3 +4.1Scoring Algorithm 3 +4.2Offline Data Management 3 +4.3Fetching Data from Games 3 +5Design Details 4 +5.1Class Descriptions and Interactions 4 +5.2UML Diagram of Classes 4 -Purpose +1 Purpose This document describes all components of the Leaguer Tournament management system. Leaguer is a software to be installed and run on a server. TODO. ANDREW COMPLETE THIS. -Non-Functional Requirements +2 Non-Functional Requirements TODO Guntas. Email dunsmore and marco about this, then fill it out. -Design Outlines -Design Decisions and Components +3 Design Outlines +3.1 Design Decisions and Components Our system will on the Model 2 design pattern/architecture. TODO: Davis – add the purpose of EACH component as a list. Controllers – The controllers will control any logic necessary to obtain the correct content for display. It then places the content in the request and decides which view it will be passed to. Models – The classes in the UML document below will reside in the model… @@ -62,18 +56,24 @@ Option 1: One of our interfaces could be “Scoring System” which will be impl Option 2: We could design an API in which the host writes a method to update the scoring. This is pretty complex, and while it would allow more customization, it is hard to imagine completing this task without first completing option 1. -Offline Data Management +4.2 Offline Data Management TODO – Nathniel write this -Fetching Data from Games +4.3 Fetching Data from Games TODO – Nathaniel write this. -Design Details -Class Descriptions and Interactions -TODO – I will do this, but Andrew you will guide me through some of the ideas -Note – All of these classes are represented in the “Model” part of the Model 2 software pattern. +5 Design Details +5.1 Class Descriptions and Interactions + +VIEWS +Webpage: An abstract HTML file, all entries below are webpages (we represent them as subclasses of the abstract “Webpage” class. All webpages will send HTTP requests to the server. Most of the visual effects and update the display with Javascript methods. Each page will have a link to either the login or the logged in user’s page. +Homepage: This page has 3 basic options. Visually simple – two large buttons on a white screen, and a search bar above them. The search bar will allow you to search upcoming or current searchable tournaments. Log in (which will take you to the login page) and “Go to Tournament” in which you enter a tournament title. This interacts with the Homepage Controller. +Login: Page with form entries for username, password. If user clicks “new user” more forms entries will appear. One for repeating the password, and one for email. This interacts with the Login controller. +Tournament: A tree-like display of pairs of matches, where each match consists of a pair of teams. All users can click on a match to go to that match’s page. Host can see a gear on top left corner that represents tournament settings. This will open up more options for the host to change. This interacts with the tournament controller. +Match: A display of both teams. + Server: Rails’ Server class handles all HTTP events. Our Server class is the class that is the main program. It instantiates other classes, manages requests from Views, and runs static methods. User: A class that represents someone using the Views (HTML, javascript) the user is in competitions and -UML Diagram of Classes -TODO – I’m working on this +5.2 UML Diagram of Classes +TODO – I’m working on this – see images.pptx |