Skip to content
Prime3vil
SURFsUP
Public

About

Tactical coastal reconnaissance & global surf intelligence platform featuring real-time beach webcams, live CCTV streams, swell forecasts, and interactive geospatial mapping across Android, Linux, Windows, and macOS.

Topics

cctvcoastal-reconcross-platformelectronkotlinleafletlivestreamsmarine-weathersurfwebcams

Resources

Readme
MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

🏄 SURFsUP // Orbital Surf Recon

License: MIT Platforms Tech Stack Interface

A tactical coastal reconnaissance and global surf intelligence platform featuring real-time beach webcams, live CCTV streams, swell forecasts, and interactive geospatial mapping across Android, Linux, Windows, and macOS.

🌊 Overview

SURFsUP is a cross-platform coastal surveillance application designed for surfers, oceanographers, and coastal observers. Styled with an "Orbital Recon" tactical HUD, it maps premier surf breaks, reefs, and point breaks worldwide, providing live CCTV feeds, webcam streams, and marine weather forecasts directly within an interactive geospatial console.

✨ Features

  • 🛰️ Orbital Recon Interactive Map:
    • Global map view powered by Leaflet and high-performance MarkerCluster.
    • Instant pin clustering and smooth panning across global coastlines.
    • Detailed spot cards showing break type, swell direction, wind orientation, and live status.
  • 📹 Live Coastal CCTV & Webcam Feeds:
    • Embedded real-time video streams (HLS .m3u8, YouTube live, EarthCam, HDOnTap, SurfGuru, Ozolio, WetMet, and direct camera links).
    • Clean video modal with theater view and stream controls.
  • 📊 Marine Weather & Surf Forecasts:
    • Live swell height, wave period, tide predictions, and wind speeds.
    • Break classification (Beach Break, Reef Break, Point Break, Rivermouth).
  • 🔍 Fast Search & Filter:
    • Instant search across hundreds of spots by name, coastline, country, or camera availability.
    • Quick-jump navigation with keyboard shortcuts (/ to focus search).
  • 🐍 Extensible Data Pipelines (scripts/):
    • Automated Python utilities to ingest, deduplicate, scrape, and export global surf spots and live webcam endpoints.
  • 🌐 4-Platform Native Support:
    • Android: Native Kotlin application with hardware acceleration and full-screen WebView.
    • Linux: Standalone desktop build for Linux distributions (Fedora, Ubuntu, Arch).
    • Windows: Native Windows 10/11 x64 application with packaged installer.
    • macOS: Universal desktop client with native support for both Apple Silicon (M-series) and Intel architectures.

🏗️ Architecture

SURFsUP/
├── app/                  # Android Native Client (Kotlin, Jetpack, WebView)
│   ├── src/main/java/    # Android bridge & activity lifecycle
│   └── src/main/assets/  # Core web application assets & database
├── Linux app/            # Linux Desktop Client (Electron)
│   ├── main.js           # Electron lifecycle & window management
│   ├── preload.js        # IPC communication bridge
│   └── src/              # Packaged application sources
├── Windows app/          # Windows Desktop Client (Electron)
│   ├── main.js           # Electron lifecycle & Windows tray integration
│   └── preload.js        # IPC communication bridge
├── Mac app/              # macOS Desktop Client (Electron)
│   ├── main.js           # macOS dock & window handlers
│   └── preload.js        # IPC communication bridge
├── scripts/              # Python Data & Scraping Pipelines
│   ├── add_forecast_spots.py  # Forecast data scraper & enricher
│   ├── export_spots_json.py   # Database synchronization tool
│   └── generate_spots.py      # Automated spot generator
└── spots.json            # Centralized coastal reconnaissance database

🚀 Installation & Setup

1. Android (app/)

Requirements: Android Studio or Android SDK (API 34+), Java 17+.

# Debug build:
./gradlew assembleDebug

# Release build:
./gradlew assembleRelease

# Output APK: app/build/outputs/apk/release/app-release.apk

2. Linux Desktop (Linux app/)

Requirements: Node.js 18+ and npm.

cd "Linux app"

# Install dependencies:
npm install

# Run in development mode:
npm start

# Build packaged distributable:
npm run dist:linux

3. Windows Desktop (Windows app/)

Requirements: Node.js 18+ and npm.

cd "Windows app"

# Install dependencies:
npm install

# Run in development mode:
npm start

# Build packaged distributable:
npm run dist:win

4. macOS Desktop (Mac app/)

Requirements: macOS 12+, Node.js 18+, and npm.

cd "Mac app"

# Install dependencies:
npm install

# Run in development mode:
npm start

# Build packaged distributable:
npm run dist:mac

5. Running the Data Scripts (scripts/)

Requirements: Python 3.10+.

cd scripts
python3 export_spots_json.py

📦 Pre-Built Binaries

Packaged installers and portable archives are available under Releases:

  • Android: SURFsUP.apk (Universal APK)
  • Linux (x64): SURFsUP-Linux-x64.zip
  • Windows (x64): SURFsUP-Windows-x64.zip
  • macOS (Apple Silicon): SURFsUP-Mac-AppleSilicon-arm64.zip
  • macOS (Intel): SURFsUP-Mac-Intel-x64.zip

🖱️ GUI Installation Guide (Pre-Built Apps)

Follow the simple visual instructions below to install and launch SURFsUP through your operating system's graphical interface:

🤖 Android (SURFsUP.apk)

  1. Download SURFsUP.apk from Releases directly on your device (or transfer it from PC via USB).
  2. Open your device's Files or Downloads app and tap SURFsUP.apk.
  3. If Android displays "For your security, your phone is not allowed to install unknown apps from this source":
    • Tap Settings in the prompt.
    • Toggle "Allow from this source" to ON.
    • Tap the back arrow.
  4. Tap Install and wait for the installer to finish.
  5. Tap Open to launch the Orbital Recon console, or find the SURFsUP icon in your app drawer.

🪟 Windows (SURFsUP-Windows-x64.zip)

  1. Download SURFsUP-Windows-x64.zip from Releases.
  2. Locate the downloaded file in Windows File Explorer (in your Downloads folder).
  3. Right-click SURFsUP-Windows-x64.zip -> select Extract All... -> click Extract.
  4. Open the extracted SURFsUP-win32-x64 folder.
  5. Double-click SURFsUP.exe to launch the application.
  6. (First Launch / SmartScreen): If Windows SmartScreen displays "Windows protected your PC":
    • Click "More info".
    • Click "Run anyway".
  7. (Optional Desktop Shortcut): Right-click SURFsUP.exe -> Show more options -> Send to -> Desktop (create shortcut).

🍎 macOS (SURFsUP-Mac-AppleSilicon-arm64.zip / SURFsUP-Mac-Intel-x64.zip)

  1. Download the archive matching your Mac's processor from Releases:
    • SURFsUP-Mac-AppleSilicon-arm64.zip: For Apple Silicon (M1, M2, M3, M4) Macs.
    • SURFsUP-Mac-Intel-x64.zip: For Intel-based Macs.
  2. In Finder, double-click the .zip file to extract it.
  3. Open the extracted folder and drag SURFsUP.app into your Applications folder (/Applications).
  4. Launch SURFsUP from your Applications folder, Launchpad, or Spotlight (Cmd + Space).
  5. (First Launch / Gatekeeper Approval):
    • If macOS displays "SURFsUP cannot be opened because the developer cannot be verified":
      • Option 1: Right-click (or Control-click) SURFsUP.app in Finder -> choose Open -> click Open in the dialog.
      • Option 2: Go to System Settings -> Privacy & Security, scroll down to the Security section, and click "Open Anyway".

🐧 Linux Desktop (SURFsUP-Linux-x64.zip)

  1. Download SURFsUP-Linux-x64.zip from Releases.
  2. Open your desktop file manager (Dolphin in KDE, Nautilus / Files in GNOME) and right-click the .zip file -> choose Extract Here (or Extract Archive).
  3. Open the extracted SURFsUP-linux-x64 folder.
  4. Enable executable permission:
    • Right-click the SURFsUP binary -> select Properties.
    • Navigate to the Permissions tab.
    • Check the box "Is executable" (KDE) or "Allow executing file as program" (GNOME).
    • Click OK.
  5. Double-click SURFsUP to launch!

📜 License

Distributed under the MIT License. See LICENSE for details.

Maintained with 🌊 by Prime3vil

About

Tactical coastal reconnaissance & global surf intelligence platform featuring real-time beach webcams, live CCTV streams, swell forecasts, and interactive geospatial mapping across Android, Linux, Windows, and macOS.

Topics

cctvcoastal-reconcross-platformelectronkotlinleafletlivestreamsmarine-weathersurfwebcams

Resources

Readme
MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages