βš½πŸ†A World Cup 2018 CLI dashboard – Watch matches in your terminal
Branch: master
Clone or download
Latest commit 6f4c134 Nov 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Babel build Jun 17, 2018
fixtures Post world cup edition (1.7.0) Jul 15, 2018
src Post world cup edition (1.7.0) Jul 15, 2018
.babelrc Babel build Jun 17, 2018
.editorconfig Initial commit Jun 17, 2018
.eslintrc 1.4.0 (#30) Jul 1, 2018
.gitignore Update gitignore and npmignore Jun 17, 2018
.npmignore Include dist on npm Jun 18, 2018
.travis.yml 1.4.0 (#30) Jul 1, 2018
Dockerfile 1.3.2 (#27) Jun 30, 2018
LICENSE Add MIT license Jun 17, 2018
README.md Update README.md Nov 14, 2018
package.json Post world cup edition (1.7.0) Jul 15, 2018
screenshot.gif Update README Jul 7, 2018
yarn.lock Post world cup edition (1.7.0) Jul 15, 2018

README.md

screenshot

World Cup 2018 CLI Dashboard Build Status

forthebadge forthebadge forthebadge

Run it in docker 🐳

Pull it from Docker Hub:

docker pull cedricbl/world-cup-2018-cli-dashboard && \
docker run -ti -e TZ=America/Toronto cedricbl/world-cup-2018-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 world-cup-2018-cli-dashboard github.com/cedricblondeau/world-cup-2018-cli-dashboard && \
docker run -ti -e TZ=America/Toronto world-cup-2018-cli-dashboard

Install using npm or yarn

NPM:

npm install -g world-cup-cli-dashboard

Yarn:

yarn global add world-cup-cli-dashboard

Requires NodeJS 6+.

Usage

POST_NOTIFICATIONS=0 wc2018
  • Use ⬅️ and ➑️ keys to navigate through different different matches.
  • Set POST_NOTIFICATIONS to 1 to enable native notifications when receiving new match events such as goals, cards or substitutions (won't work in Docker).

How does it work?

Data is sourced from the awesome worldcup.sfg.io. Matches get updated each 30 seconds. Groups get updated each 2 minutes.

Terminal interface built with react-blessed.

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/world-cup-2018-cli-dashboard
cd world-cup-2018-cli-dashboard
yarn install
USE_FIXTURES=1 yarn start

Set USE_FIXTURES to 0 to use the actual API in dev.

Contributions are very welcome.

LICENSE

MIT