herponriki / it202 Goto Github PK

* Creates an entry in CompetitionParticipants
* Recalculate the Competitions.participants value based on the count of participants for this competition from the CompetitionParticipants table.
* Update the Competitions.reward based on the # of participants and the appropriate math from the competition requirements above
    * Best to do this based on a simple equation via the initial Competition data and participants
    * Do not just increment the reward
* Show proper error message if user is already registered
* Show proper confirmation if user registered successfully

* Include a weekly, monthly, and lifetime scoreboard
    * Scoreboards will show username, score, timestamp of when the score was received
    * You may manually edit some score entries in the database to show proof each scoreboard output works
* Include a link to the game
* Include a description of your project/game
* Include a proper heading

* For this milestone limit the output to a maximum of 10
* Order the results by soonest to expire

* Show 10 competitions per page
* Paginate anything after 10
* If no results, show the appropriate message

* Email, username, etc

* Top 10 Weekly
* Top 10 Monthly
* Top 10 Lifetime
* Scoreboards should show no more than 10 results; if there are no results a proper message should be displayed (i.e., “No [time period] scores to display”)

* I.e., forms/input, navigation bar, etc

* Get all expired and not paid_out and not did_calc competitions (limit to 10 at a time)
* For each competition
    * Compare the participant count against the minimum required
    * Get the top 3 winners
        * **Pick 1 (strike out the option you won’t do; do not delete):**
            * **Option 1: **Scores are calculated by the sum of the score from the Scores table where it was earned/created between Competition start and Competition expires timestamps
            * ~~**Option 2: **Where the individual score was earned/created between when the user joined the competition and when the Competition expires~~
    * Calculate the payout (reward * place_percent)
        * Round up the value (it’s ok to pay out an extra credit here and there)
    * Create entries for the Users in the CreditsHistory table
        * Apply the new values (SUM) to their credits column in the Users table after entry is added
        * Reason should be recorded as “Won {credits} credits for {place} place in Competition {name}”
    * Mark the competition as paid_out = true and did_calc = true
* Mark all invalid competitions as did_calc = true (i.e., where # of participants is less than the minimum)

* Any new entry should update the user’s credits value (do not update the User credits column directly)
    * SUM the credit_diff for the user_id to get the total

* Show latest 10
* Paginate after 10
* Show appropriate message for no results

* Have a <span style="text-decoration:underline;">Roles</span> table	(id, name, description, is_active, modified, created)
* Have a <span style="text-decoration:underline;">User Roles</span> table (id, user_id, role_id, is_active, created, modified)
* Include a function to check if a user has a specific role (we won’t use it for this milestone but it should be usable in the future)

* This includes all scoreboards (i.e., Homepage, etc)
* If the profile is private you can have the page just display “this profile is private” upon access

* Competitions will start at 1 credit (reward)
* User sets a name for the competition
* User determines % given for 1st, 2nd, and 3rd place winners
    * Combination must be equal to 100% (no more, no less)
* User determines if it’s free to join or the cost to join (min 0 for free)
* User determines the duration of the competition (in days)
* User can determine the minimum score to qualify (min 0)
* User determines minimum participants for payout (min 3)
* Show any user friendly error messages
* Show user friendly confirmation message that competition was created
* The cost to the creator of the competition will be (1 + starting reward value)
    * If they can’t afford it, the competition should not be created
    * If they can afford it, automatically add them to the competition as a participant but don’t trigger the Reward increase in the following step

* They can adjust any of the regular form values
* If the competition was expired they can update the duration to include extra time

* Alter the User table to include credits with a default of 0.
    * This field must not be incremented/decremented directly, you must use the CreditHistory table to calculate it and set it each time the credits change (hint: using SQL sum())
* Credits should show on the user’s profile page
    * You may show credits elsewhere _as well_ if you wish

* Authentication:
    * Function to check if user is logged in
    * Function should be called on appropriate pages that only allow logged in users
* Roles/Authorization:
    * Have a roles table (see below)

* There should be a <span style="text-decoration:underline;">Scores</span> 
   table (id, user_id, score, created, modified)
* Each received score should be a new entry (scores will not be updated)
    * Please let me know if your project expects a running total score

* Form Fields
    * Username, email, password, confirm password(other fields optional)
    * Email is required and must be validated
    * Username is required
    * Confirm password’s match
* <span style="text-decoration:underline;">Users</span> Table
    * Id, username, email, password (60 characters), created, modified
* Password must be hashed (plain text passwords will lose points)
* Email should be unique
* Username should be unique
* System should let user know if username or email is taken and allow the user to correct the error without wiping/clearing the form
    * The only fields that may be cleared are the password fields

* Any technical errors or debug output displayed will result in a loss of points

* Game should tell the player if they’re not logged in that their score will not be recorded.

* Logging out will redirect to login page
* User should see a message that they’ve successfully logged out
* Session should be destroyed (so the back button doesn’t allow them access back in)

* Comp_id and user_id should be a composite unique key (user can only join a competition once)

* This should be an equation based on number of participants, do not just increment the reward value (this is repeated below as well)

* Limit to 10 results
* Paginate anything after 10
* If no results, show the appropriate message
* Show the competition name, participant count, reward, the expiry date if active otherwise “expired”, whether or not they are the creator

* Form
    * User can login with **email **or **username**
        * This can be done as a single field or as two separate fields
    * Password is required
* User should see friendly error messages when an account either doesn’t exist or if passwords don’t match
* Logging in should fetch the user’s details (and roles) and save them into the session.
* User will be directed to a landing page upon login
    * This is a protected page (non-logged in users shouldn’t have access)
    * This can be home, profile, a dashboard, etc

* Shown on their profile page
* Ordered by most recent

* If profile is public, hide email address from **other** users (email address should not be publicly visible to others)

* Changing username/email should properly check to see if it’s available before allowing the change
* Any other fields should be properly validated
* Allow password reset (only if the existing correct password is provided)
    * Hint: logic for the password check would be similar to login