Scorekeeping By Rounds

This application was created to keep score of players or teams for any number of rounds (including a bonus round)
Live - Scorekeeping by Rounds Website

---

📚 Table of Contents

• What's My Purpose?
• How to Use
  • Settings
  • Score Entry
  • Rankings
• Technologies
• Getting Started (Local Setup)
  • Run Locally
  • Test
  • GitHub Hooks
  • Build
  • Deploy

---

🧠 What's My Purpose?

This single page angular frontend was created keep score of players or teams for any number of rounds (including a bonus round)

This application does support having 2 screens of the webpage open at once. For example you could have the 'Ranking' page on a different screen/monitor as the 'Score Entry' page and the 'Ranking' page will update the scores between 1-20 seconds of entering them

I was inspired to create this after attending a STL Team Transplant Trivia where they kept score for over 100 tables on an excel sheet. I met with the lady in charge and she said, we can't pay for it (being a non-profit) but would use software if I made. I was able to fulfill that request

---

🚦 How to Use

Settings

Settings - Description

• Title - The game being played (Ex. trivia or joepardy)
  
• Number of Rounds - Input the number of rounds
  
• Number of Players - Input the number of players
  
• Use Players or Teams - Are individuals or groups competing against each other?
  
• Has Bonus Round - Toggle if a bonus round applies (A bonus round replaces the lowest round)
  
• Should Sort By - Should the 'Ranking' Page sort by player/team # or what place they are in?
  
• Show Last Round - Should the 'Ranking' Page show the previous round of scores along with the total scores?
  
• Apply Scored Goes to Next Round - When the apply button is clicked on the 'Score Entry' page should it automatically navigate to the next round?
  
• Color - Choose the color scheme for the application *this is the only setting that applies on selection
  

Buttons - Description

• Apply - Applies the currectly selected settings (except for color)
  
• Reset Only Scores - Resets just the scores
  
• Reset Everything - Resets the scores and the settings
  
• Export Scores - Exports the current scores to an excel document (hopefully you'd do this when the game was over)
  

---

Score Entry

Allows the user to navigate to different rounds and input each player's/team's score for the round

The 'Apply' button must be clicked in order for the scored to be saved

---

Rankings

Shows the total scores and depending on the settings it will show the last round entered scores

---

🛠 Technologies

• Framework: Angular 8
• Testing: Karma
• Deployment: GitHub Pages

---

🚀 Getting Started (Local Setup)

• Install node - v16 is needed
• Clone repo

---

Run Locally

npm install
npm start

---

Test

• Unit
  • ng test || npm run test
• Integration
  • ng e2e || npm run e2e

---

Github Hooks

• Build
  • Trigger: On Push to Main
  • Action(s): Builds application then kicks off gh page action to deploy build output

---

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

---

Deploy

Run npm run prod to build and deploy the project. Make sure to be on master and that it is up to date before running the command. It's really meant to be a CI/CD action

---