HackingBaseball is a Flask-based web application for baseball analytics. It allows users to interact with and analyze baseball statistics.
- Browse baseball statistics by year.
- Filter data based on specific player metrics.
- Visualize player performance on a dashboard.
- Contact the admin team via an integrated contact form.
Before you begin, ensure you have met the following requirements:
- Python 3.12 or higher
Follow these steps to get your development environment set up:
- Clone the repository:
git clone https://github.com/<your-github-username>/HackingBaseball.git
- Navigate to project directory:
cd HackingBaseball
- Create and activate a python virtual environment: https://realpython.com/python-virtual-environments-a-primer/
- Install dependencies:
pip install -r requirements.txt
Create a .env
file in the root directory of the project with the following content:
SECRET_KEY=your_secret_key
MAIL_USERNAME=your_email_username
MAIL_PASSWORD=your_email_password
Replace your_secret_key
, your_email_username
, and your_email_password
with your actual details.
Run the application using Flask's built-in server: flask run
The app will be accessible at http://127.0.0.1:5000
.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE
file for details.
If you have any questions or comments, please feel free to contact the project maintainers.
Remember to replace <your-github-username>
with your actual GitHub username and fill in your actual email credentials in the .env
file (but do not commit the .env
file to your repository).