diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.~lock.DesignDocument.docx# | 1 | ||||
| -rw-r--r-- | docs/DesignDocument.md | 26 |
2 files changed, 19 insertions, 8 deletions
diff --git a/docs/.~lock.DesignDocument.docx# b/docs/.~lock.DesignDocument.docx# new file mode 100644 index 0000000..50859f6 --- /dev/null +++ b/docs/.~lock.DesignDocument.docx# @@ -0,0 +1 @@ +Davis ,amelia,Amelia,10.02.2014 10:30,file:///home/amelia/.config/libreoffice/3;
\ No newline at end of file diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md index 69214a5..7d9bc14 100644 --- a/docs/DesignDocument.md +++ b/docs/DesignDocument.md @@ -32,16 +32,25 @@ This document describes all components of the Leaguer Tournament management syst TODO Guntas. Email dunsmore and marco about this, then fill it out. 3 Design Outlines -3.1 Design Decisions and Components +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 – These will be…. -Models – The classes in the UML document below will residee in the model… -Views – Views will be the HTML pages for Leaguer, and will -3.2 Component Interaction -TODO – Luke you know more about Model 2. Help Davis with his section. -4 Design Issues +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… +Views – Views will be the HTML pages for Leaguer, and will display the users desired content inside of the web browser. +Component Interaction + + Controllers will be used to run all of the background work of Leaguer. They will fetch the necessary data and will tell the view what to do. We will be implementing seven controllers into Leaguer. Those will be: + I. PM & Alerts – This controller will be used for sending and receiving private messages to and from the host. Players will be able to message the host in order to inform him/her of anything during the tournament. This will also allow the host to post any notifications he or she desires that will be displayed for all to see. + II. Homepage – Used to handle the homepage. This will be the first web page seen by any user of the application. + III. Login – This controller will be used when a user attempts to sign in to their profile on Leaguer. + IV. Search – This controller will be used to search the web-base for on going tournaments, players and past tournaments. + V. Tournament – Used for setting up a tournament. This will be restricted to the host of the tournament. + VI. User – The controller that will take each user to their own profile. + VII. Match/Peer Review – used for gather game statistics and the separate player reviews. +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. +Design Issues -4.1 Scoring Algorithm +Scoring Algorithm In an effort to keep our system broad, one of our requirements is that Leaguer is adaptable to many competitions, not just League of Legends. How do we assure that the different scoring systems of different sports are represented in Leaguer? Option 1: One of our interfaces could be “Scoring System” which will be implemented by many classes with common scoring systems. For example there would be a implementing class in which the highest score wins, and one in which the lowest score wins. This is likely to be the winning option, as there are not too many obscure scoring systems that we could not think of. @@ -61,6 +70,7 @@ Homepage: This page has 3 basic options. Visually simple – two large buttons o 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 |