CoolFace
Apppublic

collins909/uct-jammie-shuttle

sourceHugging Facemitupdated 2mo agoView on Hugging Face
0likes
App README

🚌 UCT Shuttle App

A comprehensive Progressive Web App (PWA) for finding UCT shuttle stops, routes, and departure times with real-time updates and offline functionality.

✨ Features

🎯 Core Functionality

  • β€”πŸ“ Exact Location Detection - Uses your precise coordinates (-33.9824199576228, 18.480131989270745)
  • β€”πŸšŒ All 15 Shuttle Stops - Complete list with accurate coordinates and bus emojis
  • —⏰ Real-time Departure Times - Next 5 departures with exact 24-hour format (18:30:45 PM)
  • β€”πŸ—ΊοΈ Interactive Map - All stops highlighted with color-coded bus emojis
  • β€”πŸ  UCT Residences - 6 registered residences within shuttle radius
  • β€”πŸ“± Progressive Web App - Install on Android like a native app

🎨 Enhanced Features

  • β€”πŸŽ― 15m Accuracy Requirement - Precise location detection
  • —⏰ Exact Time Display - No rounding, shows seconds (18:30:45 PM)
  • β€”πŸšŒ Bus Emojis - All shuttle stops use bus emojis (not train emojis)
  • β€”πŸ  Residence Integration - UCT residences with house emojis
  • β€”πŸ“± Sidebar Menu - Reminders, favorites, history, settings
  • β€”πŸ”” Reminder System - Set alerts for specific departure times
  • β€”πŸ“‹ UCT Access Notice - Dismissible notice about UCT access requirements

πŸ—ΊοΈ Map Features

  • β€”πŸšŒ All Stops Map - View all 15 shuttle stops with bus emojis
  • β€”πŸš‰ Transport Hubs - Filter to show train station stops
  • β€”πŸ« Campus Stops - Filter to show campus locations
  • β€”πŸ’ Buildings - Filter to show academic buildings
  • β€”πŸ  Residences - Filter to show UCT residences
  • β€”πŸ“ Your Location - Add your location marker to map

πŸ“± Android Installation

πŸš€ Quick Start

bash
# Run the launcher script
./launch-app.sh

# Or start manually
python3 -m http.server 8000

πŸ“± Install on Android Phone

  1. 1.Open Chrome on your Android phone
  2. 2.Navigate to: http://YOUR_COMPUTER_IP:8000
  3. 3.Tap menu (3 dots) β†’ "Add to Home screen"
  4. 4.Install and launch from home screen

🎯 PWA Features

  • β€”Native app experience - Full-screen mode, no browser bars
  • β€”Home screen icon - Launch like any Android app
  • β€”Offline functionality - Works without internet after first visit
  • β€”App shortcuts - Long-press icon for quick actions
  • β€”Push notifications - For departure reminders

πŸ—‚οΈ File Structure

uct-shuttle-app/
β”œβ”€β”€ index.html              # Main app file
β”œβ”€β”€ app.js                  # App functionality
β”œβ”€β”€ shuttle-data.js         # Shuttle routes and stops data
β”œβ”€β”€ manifest.json           # PWA configuration
β”œβ”€β”€ sw.js                   # Service worker for offline
β”œβ”€β”€ launch-app.sh           # App launcher script
β”œβ”€β”€ create-icons.html       # Icon generator tool
β”œβ”€β”€ ANDROID_INSTALL_GUIDE.md # Installation guide
β”œβ”€β”€ icons/                  # App icons directory
└── README.md              # This file

🎯 Shuttle Stops (15 Total)

🚌 Transport Hubs (4)

  1. 1.Claremont Station - -33.97971764140695, 18.466003858774812
  2. 2.Sandown Station - -33.963921897506864, 18.47731704163369
  3. 3.Forest Hill Station - -33.946694800342435, 18.470204922684683
  4. 4.Rochester Station - -33.9372611930266, 18.46072733402598

🏫 Campus Stops (2)

  1. 1.UCT Upper Campus - North Stop - -33.95489036449188, 18.46154274184408
  2. 2.UCT Upper Campus - South Stop - -33.960713941648194, 18.46027963227716

🏒 Buildings & Halls (5)

  1. 1.Bremner Building - -33.95720200809019, 18.467120975034234
  2. 2.Clarinus Building - -33.940921721444404, 18.459067717197993
  3. 3.Liesbeeck Building - -33.94813773076761, 18.4760487824711
  4. 4.Tugwell Hall - -33.954716312818135, 18.47083295642717
  5. 5.Hiddingh Hall - -33.929872343131606, 18.4137316793237

πŸ“ Other Locations (4)

  1. 1.Mowbray Station - -33.94814357492514, 18.47372351113447
  2. 2.Obz Square - -33.94377040697747, 18.46867340370806
  3. 3.Medical School - -33.94194851946926, 18.4649911447082
  4. 4.Rocco Mama Stop - -33.96056063406291, 18.469923531915175

🏠 UCT Residences (6 Total)

  1. 1.Smuts Hall - 400 students, 150m from North Stop
  2. 2.Fuller Hall - 350 students, 200m from North Stop
  3. 3.Leo Marquard Hall - 250 students, 180m from North Stop
  4. 4.College House - 180 students, 120m from North Stop
  5. 5.Kopano Residence - 320 students, 250m from North Stop
  6. 6.Glendower Residence - 150 students, 300m from North Stop

πŸš€ How to Use

πŸ“ Get Your Location

  1. 1.Click "πŸ“ Get My Location" - Standard GPS with 15m accuracy
  2. 2.Click "πŸ“ Use My Exact Location" - Your precise coordinates
  3. 3.Allow location access when prompted

🎯 Find Your Route

  1. 1.Select destination from dropdown (all 15 stops available)
  2. 2.Click "Find My Route" - Shows nearest shuttle stops
  3. 3.View departure times - Next 5 departures with exact times
  4. 4.See on map - Interactive map with route directions

πŸ—ΊοΈ Explore the Map

  1. 1.Click sidebar menu (☰) on the left
  2. 2.Select "πŸ—ΊοΈ Maps" section
  3. 3.Choose view: All stops, Transport hubs, Campus stops, Buildings, Residences
  4. 4.Click bus emojis for stop details and coordinates

πŸ”” Set Reminders

  1. 1.Click sidebar menu (☰)
  2. 2.Select "πŸ”” Reminders"
  3. 3.Set departure time and stop
  4. 4.Get notified when shuttle is about to leave

πŸ› οΈ Technical Details

πŸ“± PWA Configuration

  • β€”Manifest: manifest.json with app icons and theme
  • β€”Service Worker: sw.js for offline caching
  • β€”Icons: Generated for all Android sizes (72x72 to 512x512)
  • β€”Theme: UCT colors (#667eea, #764ba2)

🎯 Location Services

  • β€”GPS Integration: Multiple fallback methods
  • β€”Accuracy Requirement: 15 meters maximum
  • β€”Exact Coordinates: Your precise location built-in
  • β€”Validation: Cape Town area bounds checking

⏰ Time System

  • β€”24-hour Format: 18:30:45 PM (not 06:30:45 PM)
  • β€”Exact Times: No rounding, shows seconds
  • β€”Real-time Updates: Every second countdown
  • β€”Local Time: Africa/Johannesburg timezone

πŸ“‹ Requirements

πŸ’» Development

  • β€”Python 3 - For local web server
  • β€”Modern Browser - Chrome recommended for PWA
  • β€”Internet Connection - For first visit and map tiles

πŸ“± Android Phone

  • β€”Android 5.0+ (API level 21+)
  • β€”Chrome Browser - For PWA installation
  • β€”GPS/Location Services - For accurate positioning

🎯 Success!

Your UCT Shuttle app is now ready with:

  • β€”βœ… All 15 shuttle stops with exact coordinates
  • β€”βœ… Real-time departure times with 24-hour format
  • β€”βœ… Interactive map with bus emojis
  • β€”βœ… UCT residences integration
  • β€”βœ… PWA ready for Android installation
  • β€”βœ… Offline functionality after first visit
  • β€”βœ… Exact location with 15m accuracy requirement

Launch the app and enjoy your UCT Shuttle experience! πŸšŒπŸ“±βœ¨