Skip to content

About

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

Β 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🏯 Monastery360

Digitize & Experience the Spirit of Sikkim's Monasteries

An immersive web platform for exploring Sikkim's sacred monasteries through 360Β° virtual tours, interactive maps, multilingual audio guides, a cultural events calendar, a digital archive of ancient artifacts, and an AI-powered guide.

🌐 Live Demo Β |Β  πŸ“‚ Repository


πŸ“Έ Screenshots

🏠 Home β€” Hero Section

Screenshot 2026-04-01 161531

πŸ—ΊοΈ Explore Map β€” Interactive Sacred Sites

Screenshot 2026-04-01 161616

πŸ“š Digital Archive β€” Sacred Artifacts & Texts

Screenshot 2026-04-01 161633

🎧 Audio Guide β€” Immersive Audio Experience

Screenshot 2026-04-01 161558

✨ Features

Feature Description
🌐 360° Virtual Tours Immersive monastery walkthroughs using A-Frame & Three.js
πŸ—ΊοΈ Interactive Map Explore all sacred sites across Sikkim with filters by location, century, and festival
πŸ“š Digital Archive Browse 847+ digitally preserved manuscripts, murals, prayer scrolls, and ritual artifacts
🎧 Audio Guides Multilingual narrations with offline support and per-monastery playlists
πŸ“… Cultural Calendar Upcoming monastery events, festivals, and ceremonies
πŸ€– AI Guide (Gemini) Ask questions about monasteries β€” powered by Gemini 1.5 Flash
πŸ” Firebase Auth Sign in with Google/Email via Firebase Authentication
πŸŒ™ Dark / Light Mode Full theme toggle across all pages
πŸ“– Community Shared experiences and user-contributed content

πŸ—οΈ Project Structure

Monastery360/
β”œβ”€β”€ backend/                         # Spring Boot (Java 17)
β”‚   └── src/main/java/com/monastery360/
β”‚       β”œβ”€β”€ controller/
β”‚       β”‚   β”œβ”€β”€ MonasteryController.java   # GET /api/monasteries
β”‚       β”‚   β”œβ”€β”€ EventController.java       # GET /api/events
β”‚       β”‚   └── HealthController.java      # GET /health
β”‚       β”œβ”€β”€ model/                         # Monastery, Event
β”‚       β”œβ”€β”€ dto/                           # ApiResponse<T>
β”‚       └── service/                       # In-memory service layer
β”‚
β”œβ”€β”€ src/                             # React + TypeScript frontend
β”‚   β”œβ”€β”€ components/                  # Pages, UI, 360Β° viewers
β”‚   β”œβ”€β”€ contexts/                    # Auth, Chatbot context
β”‚   β”œβ”€β”€ data/                        # Audio metadata
β”‚   β”œβ”€β”€ lib/firebase.ts              # Firebase init
β”‚   β”œβ”€β”€ services/gemini.ts           # Gemini REST integration
β”‚   β”œβ”€β”€ App.tsx                      # Router & layout
β”‚   └── main.tsx                     # Entry point
β”‚
β”œβ”€β”€ public/                          # Static audio/video assets
β”œβ”€β”€ build/                           # Production build output
β”œβ”€β”€ vite.config.ts                   # Dev server, proxy, asset config
β”œβ”€β”€ firebase.json
└── vercel.json

πŸ› οΈ Tech Stack

Frontend

Backend

  • Spring Boot 3 (Java 17)
  • RESTful JSON APIs wrapped in ApiResponse<T>

Cloud & AI


βš™οΈ Prerequisites

  • Node.js 18+ and npm
  • Java 17 and Maven
  • Firebase project (for Auth / Firestore)
  • Google Cloud API key (for Gemini chatbot β€” optional)

πŸš€ Setup & Development

1. Clone the repository

git clone https://github.com/Rishankgupta08/Monastery360.git
cd Monastery360

2. Frontend

npm install
npm run dev
# Runs at http://localhost:3000

3. Backend

cd backend
mvn spring-boot:run
# Runs at http://localhost:8080

4. Environment Variables

Create a .env file at the project root:

# Firebase (required for Auth & Firestore)
VITE_FIREBASE_API_KEY=...
VITE_FIREBASE_AUTH_DOMAIN=...
VITE_FIREBASE_PROJECT_ID=...
VITE_FIREBASE_STORAGE_BUCKET=...
VITE_FIREBASE_MESSAGING_SENDER_ID=...
VITE_FIREBASE_APP_ID=...

# Gemini AI chatbot (optional but recommended)
VITE_GEMINI_API_KEY=...

Vite only exposes variables prefixed with VITE_ to the browser.


πŸ“‘ API Reference

Base URL: http://localhost:8080

Method Endpoint Description
GET / Health check string
GET /health Basic health response
GET /api/health { success: true, data: "ok" }
GET /api/monasteries { success: true, data: Monastery[] }
GET /api/events { success: true, data: Event[] }

All responses are wrapped in ApiResponse<T>. Dev CORS allows http://localhost:3000.


πŸ“¦ Build & Deploy

npm run build
# Output: /build directory

Deploy the /build folder to any static host β€” Firebase Hosting, Vercel, Netlify, or S3/CloudFront. Ensure backend CORS is configured for your production origin.


🎡 Audio & Video Assets

  • Media files live under public/assets/{audio,videos}/
  • Supported formats: .mp3, .mp4, .mkv, .webm, .ogg
  • Vite's assetsInclude config handles all media types
  • See AUDIO_INTEGRATION_GUIDE.md and AUDIO_PLAYBACK_EXPLAINED.md for details

πŸ”₯ Firebase & AI Setup

  • Firebase config is loaded from VITE_FIREBASE_* env vars in src/lib/firebase.ts
  • Analytics is initialized only in browser environments where supported
  • Gemini integration lives in src/services/gemini.ts β€” set VITE_GEMINI_API_KEY to enable

Additional guides included in the repo:

  • FIREBASE_SETUP.md β€” initial project configuration
  • FIREBASE_AUTH_FIX.md β€” common auth troubleshooting
  • FIREBASE_CONSOLE_CHECKLIST.md β€” pre-launch checklist
  • CURRENT_SETUP_GUIDE.md β€” complete local setup walkthrough
  • FINAL_IMPLEMENTATION_SUMMARY.md β€” architecture summary

πŸ› Troubleshooting

Issue Fix
Backend unreachable banner Ensure backend runs on :8080 or update vite.config.ts proxy
CORS errors Verify @CrossOrigin on controllers matches your frontend origin
Firebase init errors Confirm all VITE_FIREBASE_* env vars match your Firebase project
Gemini returns null Verify VITE_GEMINI_API_KEY is set and the Gemini endpoint is reachable
Audio/video not loading Confirm file types are in vite.config.ts assetsInclude and files exist under public/

πŸ“„ License

This project is provided as-is for demonstration and educational purposes. Please add an appropriate license file if you intend to use or redistribute it.


Built with ❀️ for preserving Sikkim's Buddhist heritage

About

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages