skekre98 / NBA-Search

flask application designed to explore NBA statistics :basketball:
78 stars 76 forks source link
beautifulsoup4 flask javascript pandas python3 scikit-learn

NBA-Search

This is an NBA Analytics website with multiple components such as a chatbot, blogs, and predictions. All the data for the site is being scraped from Basketball Reference. This project is made possible by the hard working members of the open source community!

System Design

System Design

Building locally

  1. Clone the repository locally:

    git clone https://github.com/skekre98/NBA-Search.git
  2. Run the following command to set up all necessary dependencies:

    ./setup.sh
    • you will likely need to give the setup script permission to execute
  3. Run the following command to deploy the web app on your localhost:

    python main.py run

  4. Run the following command to run the unit tests:

    python main.py test

    You can also add you own unit tests in test.py

Contributing

There is a lot to do so contributions are really appreciated! This is a great project for early stage developers to work with.

To begin it is recommended to start with issues labelled as good first issue.

How to get started:

  1. Fork the NBA-Search repo.
  2. Create a new branch in you current repo from the 'master' branch with issue label.
  3. 'Check out' the code with Git or GitHub Desktop
  4. Check contributing.md
  5. Push commits and create a Pull Request (PR) to NBA-Search

Dependencies