Skip to content

rfwilliams11/tipoff

Repository files navigation

Tipoff - NBA Terminal Viewer

Follow live NBA games directly in your terminal!

screenshot

Why?

A quick, discreet way to follow live NBA games or follow up on missed matchups from the night before

Inspired by playball

Quick Start

npx nba-tipoff

Installation

npm install -g nba-tipoff

Development

Setup

# Clone the repository
git clone https://github.com/rfwilliams11/tipoff.git
cd tipoff

# Install dependencies
npm install

# Link the package locally for testing the CLI
npm link

Running the Application

# Run in development mode
npm run dev

# Or use the CLI command (if linked)
nba-tipoff

Testing

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

Features

  • View today's NBA games in terminal
  • Navigate between different dates
  • View detailed game information with live updates
  • Real-time statistics and play-by-play
  • Keyboard navigation and shortcuts

Keyboard Controls

Scoreboard View

  • / or j/k - Navigate between games
  • Enter - View detailed game information
  • n - Next day
  • p - Previous day
  • t - Go to today
  • q or Esc - Quit

Game Detail View

  • c - Return to scoreboard
  • q or Esc - Quit

License

MIT

About

A command-line interface for watching live NBA games in your terminal

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published