gomlb

README

gomlb

A terminal based application for viewing live and past MLB games and statistics


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

gomlb is a terminal based user interface that allows you to scroll through both live and completed MLB games and browse scores, players, and statistics.

(back to top)

Built With

• Go
• Bubbletea
• Lipgloss
• Bubbles
• Bubble-table

(back to top)

Installation

go install github.com/axbolduc/gomlb@latest

(back to top)

Usage

By default running the application will open the game list view with the games from today's date. If you want to specify a specific date to open up to you can do so by doing

gomlb -d YYYY-MM-DD

(back to top)

Roadmap

• List of games for a given day
• Game View
  • Score Display
  • Line Score
  • Batters Box Score
  • Pitchers Box Score
  • Other Box Score Info
• Player View
  • Bio Information
  • Season Stats
  • Career Stats
• Better Schedule View
  • View scheduled/upcoming games
  • Calendar view?

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL License. See LICENSE for more information.

(back to top)

Contact

Alex Bolduc - Linkedin

Project Link: https://github.com/AxBolduc/gomlb

(back to top)

Acknowledgments

• nbacli for inspiration and code snippets

(back to top)