Skip to content

sunsreddit/gamethread

Repository files navigation


Logo

☀️ Phoenix Suns Game Thread Generator 🤖

An automated service that creates a r/SUNS sub-reddit post of the latest scheduled Phoenix Suns game!
Explore the docs »

View Project · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Roadmap
  6. License
  7. Contact

About The Project

As our amazing basketball community grows, the r/SUNS subreddit is developing tools like this gamethread generator to help automate tasks which helps promote the highest quality of content. The "Phoenix Suns Game Thread Generator" retrieves the latest schedule and creates a subreddit post with the pertinent details of the match, location, and other fun statistics.

Built With

  • Node
  • Docker

Getting Started

The following prerequisites and requirements are necessary for the success of this project:

Prerequisites

  • Docker / Docker Compose
  • Node.js 19+

Usage

TO DO

Contributing

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/project-id)
  3. Commit your Changes (git commit -m 'Add the thing')
  4. Push to the Branch (git push origin feature/project-id)
  5. Open a Pull Request

Roadmap

TO DO Description OpenProject ID Status
Usage Add "Usage" instructions in the README.md [TBD] 📑 Open
Unit Tests Jest Unit Testing for all modules in the directory: ./src/ [TBD] 📑 Open
Automation A Docker service that automates the projects actions GAMETHREAD-112 ✏️ In Progress

License

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

Contact

u/bruxc

(back to top)

About

Phoenix Suns Game Thread Generator

Resources

License

Stars

Watchers

Forks

Packages

No packages published