Skip to content

CornerSyrup/viture-hud

Repository files navigation

HUD for Viture ✨

A minimalist heads-up display interface for your day-to-day information needs, offering essential details at a glance – with a dash of excitement! 💥

Features 🚀

  • 🌤️ Weather Widget Real-time weather from the Open-Meteo API, complete with forecasts to keep you one step ahead of the elements!
  • ⚡ System Status Keep an eye on battery, network, and storage info so you’re always in the loop!
  • 🎵 Music Player Play local audio files, control the tunes, and jam out in style!
  • 🔔 Notification Centre Stay up to date with system notifications, without missing a beat!
  • 🕰️ Time Display Check the current date and time at a glance – never be late again!
  • 📍 Nearby POI Discover points of interest near your location using OpenStreetMap. Adventure awaits!
  • 🎯 Sniper Scope Military-style scope with a mil scale for precise distance estimation – hit your target every time!
  • 🧭 Compass Stay on track with your current heading and cardinal direction!
  • 🖤 Pure Black Background Optimised for OLED screens to give a transparent effect and save battery power!

Technologies Used 🛠️

  • React 18
  • TypeScript
  • Tailwind CSS
  • Lucide React Icons
  • Web APIs (Battery, Geolocation, Storage, DeviceOrientation)
  • OpenStreetMap (nearby POI)
  • Overpass API (weather)

Deployment to GitHub Pages 📦

This project is set up for a straightforward deployment process:

  1. Fork or Clone this repository
  2. Push to your main branch
  3. GitHub Actions will automatically build and deploy to GitHub Pages

Local Development 🏗️

  1. Clone the repository
  2. Install dependencies with npm install
  3. Run the development server with npm start
  4. Build for production with npm run build

Usage 🏃‍♀️

  • Use arrow keys to navigate between widgets
  • Press Enter to interact with the focused widget
  • Designed for pure black backgrounds to work seamlessly with OLED displays

Credits 💖

This project was made with a little help from v0.dev, Vercel's AI-powered development tool. With v0.dev we:

  • Created an intuitive and responsive UI
  • Integrated Web APIs for real-time data
  • Structured everything for maintainability
  • Added offline capabilities via a service worker

Disclaimer ⚠️

This project is not associated or affiliated with Viture in any way. The icon used is borrowed from Viture Academy purely for convenience, as I didn’t want to spend time designing an icon. The intention is solely to make the project installable and visually complete.

Licence 📜

MIT Licence – so feel free to explore, modify, and share!