Skip to content

jorgejimenez98/marlins-affiliates-tracker

Repository files navigation

🐬 Marlins Affiliates Tracker

Track the upcoming and recent games of the Miami Marlins and their minor league affiliates in a clean, responsive interface.

🚀 Features

  • Affiliate-based filtering
  • Game status grouping (Scheduled, In Progress, Final)
  • Mobile-first responsive UI
  • PWA support
  • Multilanguage for English and Spanish

🛠️ Tech Stack


🧰 Requirements

Before you begin, ensure you have the following installed:

Tool Version Download
Node.js v24.0.0 Download Node.js
pnpm v10.14.0 Install pnpm

🚀 Getting Started

  1. Open a terminal in your computer

  2. Clone the repository

    git clone https://github.com/jorgejimenez98/marlins-affiliates-tracker.git
  3. Navigate to the project folder

    cd marlins-affiliates-tracker
  4. ⚙️ Set up the Environment Variables

    Copy the .env.example file and rename it to .env. Then fill in any required values:

    cp .env.example .env
  5. Install dependencies

    pnpm install
  6. Start the development server

    pnpm dev
  7. Open your browser

    Navigate to http://localhost:5173 to view the application.


📱 PWA Installation

This application can be installed as a Progressive Web App (PWA) for a native app-like experience:

  1. Desktop (Chrome/Edge):

    • Click the install icon in the address bar
    • Or go to Settings → Install App
  2. Mobile (iOS Safari):

    • Tap the Share button
    • Select "Add to Home Screen"
  3. Mobile (Android Chrome):

    • Tap the menu (three dots)
    • Select "Add to Home Screen"

Once installed, you can access the app directly from your home screen


🧪 Mock Data

If you're testing the application and the selected date doesn't have games in all states (Scheduled, In Progress, Final), you can enable mock data:

  1. Set the environment variable in your .env file:

    VITE_MOCK_DATA_ENABLED=true
  2. Restart the development server:

    pnpm dev

This will populate the interface with sample games in different states, allowing you to see all features in action.


📸 Previews

Desktop Mobile
Desktop View Mobile View
VS MLB Real Time Data (Marlins VS New York Yankees (Sun 08-03-2025) )
vs-mlb-data

Lighthouse (Can be improved)
lighthouse

Releases

No releases published

Packages

 
 
 

Contributors