summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAndrewMurrell <amurrel@purdue.edu>2014-02-10 12:28:27 -0500
committerAndrewMurrell <amurrel@purdue.edu>2014-02-10 12:28:27 -0500
commit1501c51cf73fc415882e951a1410256db279b328 (patch)
tree4088c2c0d050dfbe3af9382fe894d54c21505fee /docs
parent9df34f73547fa006604d33da63761ae95c944871 (diff)
parent9c0602208200dcffa970ac8268fd6d12bf3f6524 (diff)
I don't know what this commit is for, but apparently I have to do it before I can pull.
Diffstat (limited to 'docs')
-rw-r--r--docs/.~lock.DesignDocument.docx#1
-rw-r--r--docs/DesignDocument.md71
-rw-r--r--docs/DesignDocument_Purpose.txt18
-rw-r--r--docs/Images.pptxbin44675 -> 41303 bytes
4 files changed, 58 insertions, 32 deletions
diff --git a/docs/.~lock.DesignDocument.docx# b/docs/.~lock.DesignDocument.docx#
deleted file mode 100644
index 50859f6..0000000
--- a/docs/.~lock.DesignDocument.docx#
+++ /dev/null
@@ -1 +0,0 @@
-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 44671ff..f36b0de 100644
--- a/docs/DesignDocument.md
+++ b/docs/DesignDocument.md
@@ -24,6 +24,20 @@ Davis Webb
5.1Class Descriptions and Interactions 4
5.2UML Diagram of Classes 4
+The purpose of this document is to outlay the desgin, intent, and structure of
+the Project Leaguer tournament organizing software.
+
+Released under an open license, Project Leaguer leverages powerful web
+technologies to provide everything needed to organize an online tournament.
+Whether it's League of Legends, Chess, Poker or more, Project Leaguer provides
+tournament organizers, participants, and spectators with an online
+interface to keep up with the score.
+
+The software itself operates as a stand-alone background application
+accessible and configurable though its web interface.
+
+NOT FINISHED -- JUST COMMITING
+ANDREW COMPLETE THIS.
1 Purpose
@@ -47,22 +61,30 @@ sleek web application which manages tournaments.
TODO Guntas. Email dunsmore and marco about this, then fill it out.
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…
+
+Models – We will be using a Ruby on Rails model. The Ruby on Rails framework maps to a table in the database and a Ruby file. So a User will usually be difined as user.rb in the app/models directory and this will be linked to the table users in the database.
+
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.
+ 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.
+ 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.
+
+The Model will be the data section that will map all of the information to their proper locations in the data base
+
Design Issues
Scoring Algorithm
@@ -80,11 +102,34 @@ TODO – Nathaniel write this.
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.
+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 login dialogue which will POST to the login controller 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 cause a POST requeest to the search controller. Log in (which will cause a POST to the login controller) 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 POST to the Login controller.
+
+newTorunament: A form that interacts with users who are either hosts or becoming hosts. This interacts with tournament controller.
+
+Tournament: A tree-like display 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, it will GET the edit Tournament view. There will be an end button that will redirect to back to the homepage after posting to the tournament controller. The tournament will POST to the tournament controller.
+
+editTorunament: This view is a list of settings. Some are form entries, and some are checkboxes. More settings will be added later in develpment. This view interacts with the tournament controller.
+
+Match: A display of both teams. Each team's players are clickable which causes a GET for the player's profile HTML. A link above both teams will GET the tournament the match belongs to. This will POST its actions to the Match controller.
+
+Search: A page with a searchbar and a list of searchable tournaments that match the search query. The searchbar causes a POST to the search controller. Each entry is clickable and causes a GET to the enrry's tournament.
+
+UserProfile: A page with the user's information. One can view the player's reviews. If the user is viewing his/her own profile, they can edit it causing a POST to the userProfile controller.
+
+
+CONTROLLERS
+HomepageController: This is the main controller. It has methods showHomepage() which renders the homepage view. It has editSettings() method, that gets the current settings of the entire server, provided that the host is viewing the homepage.
+
+LoginController: This has doLogin() and doLogout(). Both have access to the HTTP requrest. It will interact with the Users model to validate passwords and usernames.
+
+TournamentController: This controller will have methods: newTorunament(), getTournament(), editTournament(), and endTournament(). All of these methods will interact with the Tournament model, and all of its fields including users matches and TournamentSettings. And all will interact with their tournament view, for example, newTournament() will render newTorunament.
+
+
+
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
diff --git a/docs/DesignDocument_Purpose.txt b/docs/DesignDocument_Purpose.txt
deleted file mode 100644
index 3bb85c1..0000000
--- a/docs/DesignDocument_Purpose.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-Purpose:
-
-The purpose of this document is to outlay the desgin, intent, and structure of
-the Project Leaguer tournament organizing software.
-
-Released under an open license, Project Leaguer leverages powerful web
-technologies to provide everything needed to organize an online tournament.
-Whether it's League of Legends, Chess, Poker, or more, Project Leaguer provides
-tournament organizers, participants, and spectators with an online
-interface to keep up with the score. Even better Project Leaguer offers scoring
-features and options which would be very difficult to implement with traditional
-tournament organizing practices such as peer review and team-independent
-individual scoring.
-
-The software itself operates as a stand-alone background server application
-accessible and configurable though its web interface which reveals to users a
-sleek web application which manages tournaments.
-
diff --git a/docs/Images.pptx b/docs/Images.pptx
index 73f002d..01e8016 100644
--- a/docs/Images.pptx
+++ b/docs/Images.pptx
Binary files differ