MWM Documentation
Video Demo
Measure What Matters Video Demonstration
Presentation Slides
User Manual
Deployment Docs
Api Docs
In order to view the MWM Api documentation locally. Run
npm run start
Then navigate to http://localhost:3001/api Note: 3001 is the default port. Remember to use the port you have set in main.ts in the backend/src directory.
The following demonstrates how db objects, api endpoints, and stats can be calculated/
Docs can be found here
Ball Possession
Ball possession can be in 3 states during a game:
- A player has the ball.
- An opponent has the ball.
- The ball is neutral.
There is a POST API endpoint that can be used to set the state of the ball. The ball is assumed to start in a neutral state at the beginning of the match AND at the beginning of the second half. When calculating stats this should be taken into account.
The timeline demonstrates how this would work.
The DELETE API endpoint does not delete the entity from the DB but instead sets an "archived" flag to true. This will allow for easier modification later.
Testing Docs
Testing Documentation
Testing Report (Selenium)
The html version can be found in the /selenium_testing/ReportDirectory/ from the root folder.