jmu-football-tracker

Football Updates Tracker

A web application that tracks and displays football team updates, including commitments, transfers, visits, and offers. I’ve made mine for the James Madison University Football team, but it can be easily adjusted for whichever you’re a fan of. The application features a responsive design with dark/light theme support and administrative capabilities for managing player data.

Features

Technology Stack

Prerequisites

Installation

  1. Clone the repository:
    git clone [repository-url]
    cd jmu-football-tracker
    
  2. Install dependencies:
    npm install
    
  3. Create a .env file in the root directory with the following variables:
    MONGODB_URI=your_mongodb_connection_string
    ADMIN_TOKEN=your_admin_password
    PORT=3000
    
  4. Start the development server:
    npm start
    
  5. Access the application at http://localhost:3000

Environment Variables

This project uses environment variables for configuration. Create a .env file in the root directory with the following variables:

MONGODB_URI=your_mongodb_connection_string
ADMIN_TOKEN=your_admin_password
PORT=3000

Important notes about environment variables:

Project Structure

jmu-football-tracker/
├── node_modules/      # Dependencies directory
├── .env              # Environment variables (not in version control)
├── .gitattributes    # Git attributes configuration
├── .gitignore        # Git ignore configuration
├── index.html        # Main HTML file
├── package-lock.json # Dependency lock file
├── package.json      # Project configuration and dependencies
├── server.js         # Express server configuration
└── styles.css        # Application styles

API Endpoints

Security

Deployment

Heroku Deployment

  1. Create a new Heroku application
  2. Connect your GitHub repository
  3. Configure environment variables in Heroku:
    • Go to Settings → Config Vars
    • Add your MONGODB_URI and ADMIN_TOKEN
  4. Deploy your application

MongoDB Atlas Setup

  1. Create a MongoDB Atlas account
  2. Set up a new cluster
  3. Create a database user
  4. Configure network access
  5. Get your connection string and add it to your environment variables

Contributing

  1. Fork the repository
  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

License

This project is licensed under the ISC License.

Acknowledgments

Disclaimer

This site is not affiliated with, endorsed by, or connected to James Madison University or its Athletics Department. All information provided is publicly available and for informational purposes only.