How pratham10805/tourism-jharkhand works
Project type and purpose
• This is a full-stack, monorepo application combining:
• A Next.js 13 “app/” front-end with server-side rendering (SSR), static asset hosting, React components, interactive maps, AR/VR views, and client-side API routes.
• A standalone Express.js backend (“backend/”) providing a RESTful API for data (places, images, payment, chatbot), user management, and business logic.
• A MongoDB database with GridFS for image storage.
• Integrations with external services: payment gateway (Razorpay), AI/chatbot service (OpenAI), and potentially blockchain data.
File structure
• Top-level “app/” folder: Next.js pages, API routes (chatbot widget, analytics export, etc.), AR/VR page, interactive map, reusable UI components (“components/” and “components/ui/”), global styles, hooks, and libs.
• “backend/”: Express server entry (server.js), controllers, routes (auth, places, payment, chatbot, travelPlanner), middleware (auth, errorHandler, upload), models (Mongoose schemas), services (blockchainService), and config/database.js.
• Config files: Dockerfile & docker-compose.yml for the backend, .env.example, tsconfig, next.config.mjs, postcss.config.mjs.
• Static assets & build outputs under “.next/” and “public/”.
Extract architecture from README
• Backend: Node.js, Express, MongoDB + GridFS, Multer for uploads, security via Helmet/CORS/rate-limiting.
• Frontend: Next.js with interactive maps (Leaflet), charts (Recharts), AR/VR previews, a chatbot widget, search/filter UIs.
• Features: upload/view images, search by proximity/district, AR/VR site preview, analytics export.
Main components & relationships
a. Frontend (Next.js app)
• UI Components (React pages, map, AR/VR, chatbot widget)
• Next API Routes (in app/api/) for light SSR-adjacent calls (e.g., analytics export)
• Static Asset Hosting via Next.js CDN (for CSS, JS, geoJSON, images)
b. Backend API (Express.js)
• Auth Service (login/registration endpoints)
• Places Service (CRUD places, search/filter)
• Images Service (GridFS file upload/download)
• Chatbot Service (message route → OpenAI)
• Payment Service (checkout/verify → Razorpay)
• Travel Planner Service (custom travel‐itinerary logic)
c. Database Layer
• MongoDB cluster for data collections (places, users, orders, feedback)
• GridFS for large images and AR/VR assets
d. External services
• Razorpay (payment processing)
• OpenAI (chatbot)
• Optional blockchain node (blockchain_data/)
e. Infrastructure
• Vercel (or similar) hosting for front-end
• Docker / Docker-Compose for backend deployment
How data flows
• User→Browser: loads SSR pages from Next.js → interacts with UI (map, listings, AR/VR, chatbot).
• Browser→Next API Routes: lightweight calls (e.g., analytics export), or directly to Express API.
• Next.js → Express API → MongoDB (via Mongoose) or GridFS.
• Express API → Razorpay for payment, → OpenAI for chatbot, → returns results to front-end.
• Static assets (geoJSON, images) served from Vercel/CDN or public/ folder.
Architectural patterns & principles
• Two-tier separation: Presentation (Next.js) vs. Business Logic + Data (Express + MongoDB).
• RESTful API design, layered controllers → services → models.
• SSR + SSG for performance, with client-side hydration.
• Modular controllers & middleware for cross-cutting concerns (auth, error handling, file upload).
• CI through Docker and docker-compose for backend, Vercel deployments for front-end.