Skip to content

Krishna-123/spritual-compass

Repository files navigation

🕉️ Spiritual Compass - Your Daily Light

A lightweight, beautiful web application designed to provide spiritual guidance and motivation through ancient wisdom from Bhagavad Gita and Ramayana.

✨ Features

  • Ancient Wisdom Quotes: Inspirational verses from Bhagavad Gita and Ramayana
  • Morning Thoughts: Uplifting messages tailored for Data Engineers
  • Beautiful Imagery: Calming, inspirational visuals
  • LocalStorage Caching: Quick access - works offline after first load
  • Mobile-First Design: Perfect for quick phone access
  • Time-Based Greetings: Personalized greetings based on time of day
  • Zero Dependencies: Single HTML file, no build process needed

🚀 Quick Start

Option 1: Open Locally

  1. Download spiritual-compass.html
  2. Double-click to open in your browser
  3. Bookmark the page for quick access
  4. Add to home screen on mobile for app-like experience

Option 2: Host for Free (Recommended)

GitHub Pages (Easiest)

  1. Create a new GitHub repository (e.g., spiritual-compass)
  2. Upload spiritual-compass.html
  3. Rename it to index.html
  4. Go to Settings → Pages
  5. Select "main" branch and save
  6. Your site will be live at https://yourusername.github.io/spiritual-compass

Netlify (Instant Deploy)

  1. Go to netlify.com
  2. Drag and drop the spiritual-compass.html file (rename to index.html first)
  3. Get instant URL like https://your-site-name.netlify.app
  4. Free SSL certificate included

Vercel (Fast & Free)

  1. Go to vercel.com
  2. Import project or upload file
  3. Deploy with one click
  4. Get URL like https://your-project.vercel.app

Google Drive (Quick Share)

  1. Upload to Google Drive
  2. Right-click → Share → Get link
  3. Make sure it's set to "Anyone with the link can view"
  4. Open on any device

📱 Add to Phone Home Screen

iPhone/iPad

  1. Open the website in Safari
  2. Tap the Share button (square with arrow)
  3. Scroll and tap "Add to Home Screen"
  4. Name it "Spiritual Compass"
  5. Tap "Add"

Android

  1. Open the website in Chrome
  2. Tap the menu (three dots)
  3. Tap "Add to Home screen"
  4. Name it "Spiritual Compass"
  5. Tap "Add"

💾 How LocalStorage Works

The app stores:

  • Last Quote: So you see the same quote when you revisit (until you refresh)
  • Last Image: Cached for quick loading
  • Visit History: Tracks your spiritual journey

All data is stored in your browser - nothing is sent to any server. It's completely private and works offline after the first load.

🎨 Customization

Add More Quotes

Edit the bhagavadGitaQuotes or ramayanaQuotes arrays in the JavaScript section:

const bhagavadGitaQuotes = [
    {
        text: "Your custom quote here",
        reference: "Chapter X, Verse Y",
        source: "Bhagavad Gita"
    },
    // Add more...
];

Change Colors

Modify the CSS variables at the top of the <style> section:

:root {
    --primary: #8B4513;      /* Main brown color */
    --secondary: #D4A574;    /* Light tan */
    --accent: #FF6B35;       /* Orange accent */
    --bg-light: #FFF8F0;     /* Background */
}

Add Real Images

Replace the SVG placeholder images with real image URLs:

const inspirationalImages = [
    {
        url: "https://your-image-url.com/sunrise.jpg",
        title: "Sunrise",
        message: "Your custom message"
    }
];

Note: For offline functionality, use base64-encoded images or host images on a CDN.

🛠️ Technical Details

  • Size: ~15KB (ultra-lightweight!)
  • Dependencies: None - pure HTML/CSS/JavaScript
  • Browser Support: All modern browsers (Chrome, Firefox, Safari, Edge)
  • Mobile Optimized: Responsive design works on all screen sizes
  • Offline Ready: Works after first load thanks to LocalStorage
  • No Backend: 100% client-side, no server needed

🧘 Usage Tips

  1. Morning Ritual: Open first thing in the morning for daily inspiration
  2. During Confusion: Quick access when feeling lost or depressed
  3. Before Important Work: Read a quote before starting data engineering tasks
  4. Bookmark It: Keep it one tap away on your phone
  5. Share It: Send the link to friends who might need spiritual guidance

🙏 Philosophy

This app is designed with love and understanding for those moments when the mind fluctuates and the path seems unclear. As a Data Engineer, your work requires focus and clarity - this tool helps you return to center when you need it most.

📜 Quotes Included

  • 10+ Bhagavad Gita verses: On karma, dharma, mind control, and self-realization
  • 8+ Ramayana teachings: On truth, patience, duty, and inner strength
  • 7+ Morning thoughts: Tailored for engineers and seekers

🔮 Future Enhancements (If You Want)

  • Add audio readings of quotes
  • Include meditation timer
  • Add more scriptures (Upanishads, Vedas)
  • Daily quote notifications
  • Journal feature to track thoughts
  • Sanskrit transliterations

📝 License

Free to use, modify, and share. May this bring peace to all who seek it.

🌟 Motivation

"You have the right to work, but never to the fruit of work."

  • Bhagavad Gita 2.47

This app was created to serve as a lighthouse when the fog of confusion rolls in. Your journey is sacred, and you're never alone on the path.


ॐ शान्तिः शान्तिः शान्तिः
Om Shanti Shanti Shanti
(Peace, Peace, Peace)

About

spritual-compass

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors