summaryrefslogtreecommitdiff
path: root/docs/DesignDocument.md
diff options
context:
space:
mode:
authorAndrewMurrell <amurrel@purdue.edu>2014-02-10 12:28:31 -0500
committerAndrewMurrell <amurrel@purdue.edu>2014-02-10 12:28:31 -0500
commita9e3b6a8f3c0ea3a177edb8f0fbf31d0949b4e32 (patch)
treefef3b4a78a982aff2bb442a55b724f643be0036d /docs/DesignDocument.md
parent1501c51cf73fc415882e951a1410256db279b328 (diff)
parentdd14781005a08cc0051f3be82ea0b9913b167fdb (diff)
Merge branch 'master' of http://github.com/LukeShu/leaguer
Diffstat (limited to 'docs/DesignDocument.md')
-rw-r--r--docs/DesignDocument.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md
index f36b0de..d20c1ed 100644
--- a/docs/DesignDocument.md
+++ b/docs/DesignDocument.md
@@ -63,7 +63,9 @@ 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.
+
+Our system will on the Model 2 design pattern/architecture.
+
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 – 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.
@@ -73,6 +75,7 @@ Views – Views will be the HTML pages for Leaguer, and will display the users d
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.
@@ -83,7 +86,7 @@ Component Interaction
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
+The Model will be the data section that will map all of the information to their proper locations in the data base.
Design Issues