Skip to content

kebson01/GameDay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1 Commit
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿˆ GameDay - College Football Tailgate Companion

GameDay is a Progressive Web App (PWA) designed to enhance your college football game day experience. Find your friends, locate your car, discover tailgates, and never miss a moment of the action!

GameDay PWA React

โœจ Features

๐Ÿ“ Find My Car

Never lose your car in a sea of 50,000 vehicles again. Drop a pin when you park, add notes and photos, and navigate back with one tap.

๐Ÿ‘ฅ Find Friends

Create groups with your tailgate crew and share real-time locations. See everyone on a map and navigate to any friend instantly.

๐ŸŽ‰ Tailgate Discovery

Browse public tailgates, RSVP to events, or host your own. Connect with fellow fans and make new friends.

๐Ÿ—บ๏ธ Campus Map

Navigate the stadium area with ease. Find restrooms, food vendors, first aid stations, and more.

๐Ÿค– AI Assistant

Powered by ChatGPT, get instant answers about tailgating tips, parking strategies, what to bring, and more.

๐Ÿ›ก๏ธ Safety Features

Quick access SOS button, check-ins with your group, and ride request features to keep everyone safe.

๐Ÿ“ฑ Works Offline

PWA architecture with IndexedDB caching means the app works even with poor stadium cell service.

๐Ÿš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/yourusername/gameday.git
cd gameday

# Install dependencies
npm install

# Create environment file
cp .env.example .env

Environment Variables

Create a .env file in the root directory:

# Google Maps API Key (required for maps)
# Get yours at: https://console.cloud.google.com/google/maps-apis
VITE_GOOGLE_MAPS_API_KEY=your_google_maps_api_key

# OpenAI API Key (required for AI assistant)
# Get yours at: https://platform.openai.com/api-keys
VITE_OPENAI_API_KEY=your_openai_api_key

Development

# Start development server
npm run dev

The app will be available at http://localhost:5173

Build for Production

# Create production build
npm run build

# Preview production build
npm run preview

๐Ÿ“ฑ PWA Installation

GameDay is a Progressive Web App that can be installed on your device:

iOS (Safari)

  1. Open the app in Safari
  2. Tap the Share button
  3. Select "Add to Home Screen"

Android (Chrome)

  1. Open the app in Chrome
  2. Tap the menu (โ‹ฎ)
  3. Select "Add to Home Screen" or "Install App"

Desktop (Chrome/Edge)

  1. Look for the install icon in the address bar
  2. Click "Install"

๐Ÿ—๏ธ Tech Stack

  • Frontend: React 18, Vite
  • Styling: Tailwind CSS, shadcn/ui
  • Maps: Google Maps API (@react-google-maps/api)
  • AI: OpenAI GPT-4o-mini
  • Sports Data: ESPN Public API (live scores, rankings, news)
  • State Management: TanStack Query (React Query)
  • Storage: Local Storage + IndexedDB (fully offline capable)
  • PWA: Vite PWA Plugin, Workbox

๐Ÿ“ Project Structure

gameday/
โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ icons/          # PWA icons
โ”‚   โ””โ”€โ”€ manifest.json   # PWA manifest
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ api/            # API clients
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ ai/         # AI assistant
โ”‚   โ”‚   โ”œโ”€โ”€ auth/       # Authentication
โ”‚   โ”‚   โ”œโ”€โ”€ common/     # Shared components
โ”‚   โ”‚   โ”œโ”€โ”€ map/        # Map components
โ”‚   โ”‚   โ”œโ”€โ”€ onboarding/ # Onboarding flow
โ”‚   โ”‚   โ””โ”€โ”€ ui/         # UI components (shadcn)
โ”‚   โ”œโ”€โ”€ hooks/          # Custom React hooks
โ”‚   โ”œโ”€โ”€ lib/            # Utilities & services
โ”‚   โ”œโ”€โ”€ pages/          # Page components
โ”‚   โ””โ”€โ”€ utils/          # Helper functions
โ”œโ”€โ”€ index.html
โ”œโ”€โ”€ vite.config.js
โ””โ”€โ”€ tailwind.config.js

๐Ÿ”’ Privacy & Security

  • Location sharing is opt-in and can be disabled at any time
  • Location is only shared with group members you choose
  • Data is encrypted in transit
  • See our Privacy Policy for more details

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  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 MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgments


Made with ๐Ÿˆ for fans everywhere

About

Sport App

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors