bmino / sparcpong

The ping pong ladder tracking the best players at Sparc

Sparc Pong

This ladder currently manages the semi-competitive ping pong scene at Sparc.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing Prerequisites

The following dependencies are required to run an instance of Sparc Pong:

1. NodeJS
2. Npm
3. Mongodb

Install NodeJS and npm

brew install node

Install Mongodb

brew install mongodb

Setup Mongodb root directory

sudo mkdir -p /data/db
sudo chmod -R a+w /data

Running the tests

npm test

Configuration

There are some required configuration parameters that must be set before starting an instance. Read the configuration documentation for instructions on setting these and other optional parameters.

Deployment

Clone the code from github

git clone https://github.com/bmino/sparcPong.git

Build the project from the root directory

npm install

Start an instance of mongodb in a new terminal tab

mongod

Start the application

npm start

Authors

• Brandon Mino - Project Lead

See also the list of contributors who participated in this project.

License

This project is licensed under mit

To fellow pong lovers, never stop spinning

sparcpong's Issues

Feature Request: Global Match History

Similar to the per user view, but a dashboard for all open challenges and all past matches.

Feature Request: link to github repo on site

I have poor memory and don't want to have two bookmarks (one for the site, one for the repo)

Feature Request: Ask for an Extension on Challenge

When a challenge is expiring and you can't make the game, it would be nice to request an extension.

It can work just like the challenge mechanism where both parties have to agree.

Profile: Delayed Score Update

After resolving a challenge, the match history will update in real time, but the score will not always reflect new matches until the page is refreshed.

This is likely due to race conditions from the socket event callbacks in teamProfileController.js

In App Scheduling

There is not an internal mechanism to schedule automated tasks such as auto-forfeiting and auto-challenging.

Sparc Pong will eventually migrate off of the Heroku platform and will require this feature.

Acceptance Criteria:

1. Application can schedule auto-forfeits
2. Application can schedule auto-challenges
3. Scheduling frequency is configurable via an environmental variable
4. Scheduling can be disabled entirely via an environmental variable
5. Scheduling framework can scale to accommodate additional tasks

Bug: Team Creation Broken

Haven't had a chance to debug yet. Just posting here for tracking purposes. Fails out during the creation of a new team with the following stacktrace in the server log:

Validating if player is a part of too many teams. ReferenceError: reject is not defined at Object.verifyPlayerCanJoinById (/Users/nicholaskraftor/sparcPong/services/TeamService.js:31:28) at /Users/nicholaskraftor/sparcPong/routes/TeamController.js:29:45 at Layer.handle [as handle_request] (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/layer.js:95:5) at next (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/route.js:137:13) at Route.dispatch (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/route.js:112:3) at Layer.handle [as handle_request] (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/layer.js:95:5) at /Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:281:22 at Function.process_params (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:335:12) at next (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:275:10) at Function.handle (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:174:3) at router (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:47:12) at Layer.handle [as handle_request] (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/layer.js:95:5) at trim_prefix (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:317:13) at /Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:284:7 at Function.process_params (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:335:12) at next (/Users/nicholaskraftor/sparcPong/node_modules/express/lib/router/index.js:275:10)

Game registered as win, but email received says loss

• Won a match
• Opponent resolved the score correctly
• App correctly reflects win
• Email received says I lost

Issue seems cosmetic since it's just an email, but thought it was worth noting.

Audit Error: nodemailer

Nodemailer is currently at version 0.7.1 due to encountering issues sending gmail messages when I originally implemented the feature. This is severely outdated compared to the current nodemailer release of 4.6.7

Acceptance Criteria:

• npm audit error relating to nodemailer is resolved
• Email functionality is not broken

Feature Request: a ReadMe

Would be nice to have a place to toss notes and setup guide for the repo, and also define the tech used and what the source/inspiration was to the file structure and coding style.