paul-tqh-nguyen / swing_dance_scores

A web interface to an implementation of a relative placement scoring system commonly used in Swing Dance competitions
0 stars 0 forks source link

swing_dance_scores

This is a web interface for performing relative placement, a common scoring mechanism used in Swing Dancing competitions.

Please also see our wiki for additional information.

We have a brief explanation of relative placement on our wiki.

For further explanation on how relative placement works, see some of the external resources on the topic that we found insightful.

Architecture

This repository provides functionality for a front-facing interface that'll perform relative scoring.

The front end and scoring mechanisms are implemented in React & Javascript.

Our serverside fucntionality for storing and updating results utilizes Firebase.

We use Python for scripting and glue code.

Instructions For Use

See the sub-sections below for details on how to use the provided functionalities.

Utilizing Our Front End Interfaces

We can use the following command to utilize our front end functionality.

./swing_dance_scores.py -start-front-end-server

This starts a server to serve our web application.

Information will be printed about the URI relevant to access our web application (the URI will be something like http://localhost:3000/).

Deployment Instructions

If local changes are made to the front end functionality, we can deploy them to our demo site at https://paul-tqh-nguyen.github.io/swing_dance_scores/ via the following command:

./swing_dance_scores.py -deploy

Troubleshooting Tips

This section contains some tips for troubleshooting any installation or run-time problems.

All of the notes below stem from troubles repoted by our end users and are stored on our wiki.

This list is incomplete.

Trouble Shooting Tips: