GithubHelp home page GithubHelp logo

parnic / mmm-shiftstats Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 215 KB

Show stats from your sports team tracked by Shift

License: MIT License

JavaScript 97.22% CSS 2.78%
magicmirror magicmirror2 digitalshift sports sports-stats hockey baseball basketball soccer lacrosse

mmm-shiftstats's Introduction

MMM-ShiftStats

A MagicMirror² module used to display stats from any DigitalShift site (HockeyShift, SoccerShift, LacrosseShift, FootballShift, BasketballShift, and BaseballShift).

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/parnic/MMM-ShiftStats.git.
  2. cd MMM-ShiftStats
  3. Execute npm install to install the node dependencies.
  4. Add the module inside config.js placing it where you prefer.

Config

Option Type Description Default
apiKey string Your API key. If not supplied, the HockeyShift Android app's key is used by default.
teamName string (REQUIRED) The name of the team you want to track.
sport string (REQUIRED) The name of the sport you want to track (e.g. 'hockey', 'soccer').
mode string What mode the module should run in. Valid values: 'standings', 'games' 'standings'
maxGames number When in games mode, how many games should be shown (it will show this many most recent games). 6
teamNameClass string CSS class to apply to displayed team names. 'light'
updateInterval number How frequently, in milliseconds, to update the info. 12 * 60 * 60 * 1000 (every 12 hours)

Here is an example of an entry in config.js

{
	module: 'MMM-ShiftStats',
	header: 'Standings',
	position: 'top_left',
	config: {
		teamName: 'Bears',
		sport: 'Hockey'
	}
},

Screenshot

Screenshot

Notes

Pull requests are very welcome! If you'd like to see any additional functionality, don't hesitate to let me know.

Dependencies

This uses a Node.JS library I created for interfacing with DigitalShift sites: node-shiftstats, so feel free to check that out for more information.

mmm-shiftstats's People

Contributors

parnic avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.