https://github.com/jorgejimenez98/marlins-affiliates-tracker
Check daily games for the Miami Marlins and their affiliate teams.
https://github.com/jorgejimenez98/marlins-affiliates-tracker
eslint i18next react react-router-dom shadcn-ui tailwindcss-v4 tankstack-query typescript vercel vite zustand
Last synced: 3 months ago
JSON representation
Check daily games for the Miami Marlins and their affiliate teams.
- Host: GitHub
- URL: https://github.com/jorgejimenez98/marlins-affiliates-tracker
- Owner: jorgejimenez98
- Created: 2025-07-31T18:56:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-15T23:46:40.000Z (10 months ago)
- Last Synced: 2025-08-16T01:30:05.814Z (10 months ago)
- Topics: eslint, i18next, react, react-router-dom, shadcn-ui, tailwindcss-v4, tankstack-query, typescript, vercel, vite, zustand
- Language: TypeScript
- Homepage: https://marlins-affiliates-tracker.vercel.app
- Size: 1.21 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐ฌ 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
- [React](https://reactjs.org/)
- [Vite](https://vitejs.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Shadcn UI](https://ui.shadcn.com/)
- [Tank Stank Query](https://tanstack.com/query/v5/docs/framework/react/overview)
- [Zustand](https://zustand-demo.pmnd.rs/)
- [Vercel](https://vercel.com/)
---
## ๐งฐ Requirements
Before you begin, ensure you have the following installed:
| Tool | Version | Download |
|------|---------|----------|
| Node.js | `v24.0.0` | [Download Node.js](https://nodejs.org/en/download/current) |
| pnpm | `v10.14.0` | [Install pnpm](https://pnpm.io/installation) |
---
## ๐ Getting Started
1. **Open a terminal in your computer**
2. **Clone the repository**
```bash
git clone https://github.com/jorgejimenez98/marlins-affiliates-tracker.git
```
3. **Navigate to the project folder**
```bash
cd marlins-affiliates-tracker
```
5. **โ๏ธ Set up the Environment Variables**
Copy the `.env.example` file and rename it to `.env`. Then fill in any required values:
```bash
cp .env.example .env
```
7. **Install dependencies**
```bash
pnpm install
```
8. **Start the development server**
```bash
pnpm dev
```
9. **Open your browser**
Navigate to [http://localhost:5173](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:
```bash
VITE_MOCK_DATA_ENABLED=true
```
2. Restart the development server:
```bash
pnpm dev
```
This will populate the interface with sample games in different states, allowing you to see all features in action.
---
## ๐ธ Previews
| Desktop | Mobile
|-----------------|----------------
|  | 
| VS MLB Real Time Data (Marlins VS New York Yankees (Sun 08-03-2025) ) |
| --------------------- |
|  |
---
| Lighthouse (Can be improved)|
| --------------------- |
|  |
---