GithubHelp home page GithubHelp logo

cedricblondeau / nhl-cli-dashboard Goto Github PK

View Code? Open in Web Editor NEW
12.0 2.0 1.0 1.2 MB

๐Ÿ’๐Ÿ†NHL CLI dashboard โ€“ Watch hockey games in your terminal

Home Page: https://www.npmjs.com/package/nhl-cli-dashboard

License: MIT License

JavaScript 94.97% Dockerfile 5.03%
hockey nhl cli dashboard blessed react-blessed react

nhl-cli-dashboard's Introduction

screenshot

NHL CLI Dashboard

forthebadge forthebadge forthebadge

Run it in docker ๐Ÿณ

Pull it from Docker Hub:

docker pull cedricbl/nhl-cli-dashboard && \
docker run -ti -e TZ=America/Toronto -e TERM=xterm-256color cedricbl/nhl-cli-dashboard

Replace America/Toronto with your actual timezone. This image is for amd64 arch only.

Or build it:

Want to build this image from a Dockerfile instead? Or do you want to run this dashboard on a non-amd64 arch, let's say arm? On a Raspberry Pi?

docker build -t cedricbl/nhl-cli-dashboard github.com/cedricblondeau/cedricbl/nhl-cli-dashboard && \
docker run -ti -e TZ=America/Toronto -e TERM=xterm-256color cedricbl/nhl-cli-dashboard

Install using npm or yarn

NPM:

npm install -g nhl-cli-dashboard

Yarn:

yarn global add nhl-cli-dashboard

Requires NodeJS 6+.

Usage

nhl-cli-dashboard
  • Use โฌ…๏ธ and โžก๏ธ keys to navigate through different different matches.

How does it work?

Data is sourced from the undocumented NHL Stats API. Matches get updated on every minutes.

Terminal interface built with react-blessed. Inspired by world-cup-2018-cli-dashboard.

FAQ

Q: Data is not showing up?

If an API call fails, we log a debug message. Press F12 to see the debug console, some helpful messages may show up (a 503 or a 429 HTTP code for instance).

Development

git clone https://github.com/cedricblondeau/nhl-cli-dashboard
cd nhl-cli-dashboard
yarn install
yarn start

Contributions are very welcome.

LICENSE

MIT

nhl-cli-dashboard's People

Contributors

cedricblondeau avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

zhblessed

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.