How altafahmed94/voyagevault works
Project type and purpose
• This is a full‑stack web application (VoyageVault) for browsing and booking vacation accommodations.
• Front‑end serves dynamic views (EJS templates), static assets (CSS, JS) and interacts with Mapbox for maps.
• Back‑end is a Node.js/Express server implementing RESTful endpoints, user authentication (Passport.js, sessions, JWT), and data validation.
• MongoDB Atlas is used for persistence; Cloudinary for image storage; OAuth providers (Google, GitHub) for third‑party login.
File structure
• Top‑level files: app.js (entry point), cloudConfig.js, schema.js (Joi schemas), middleware.js.
• Directories:
– routes: Express routers for listings, reviews, users.
– controllers: handler functions for each route grouping (listings.js, reviews.js, users.js).
– models: Mongoose schemas (listing.js, review.js, user.js).
– views: EJS templates (layouts, includes, pages) for server‑side rendering.
– public: static CSS and JS (map integration, UI scripts).
– utils: custom Error class, async wrapper.
– init: initial seed scripts (data.js).
• config files: package.json (dependencies), .gitignore, cloudConfig.js (Cloudinary setup), .env referenced.
README for additional insights
• MVC architecture is explicitly mentioned.
• Technologies: Express, Node, Passport, MongoDB, Mongoose, Joi, Multer, EJS, Mapbox API.
• Deployment on Render, DB on MongoDB Atlas, images on Cloudinary.
• OAuth with Google/GitHub, session storage in Mongo (connect-mongo).
a. Main components
– Client / Browser (mobile and desktop)
– Web Server (Express app)
· Routing layer (routes/*.js)
· Controller layer (controllers/*.js)
· Business logic / validation (schema.js, middleware.js)
· Models / Data access (models/*.js using Mongoose)
– Database (MongoDB Atlas)
– Cloudinary image store
– External services: Mapbox API, OAuth providers (Google, GitHub)
– Session store (Mongo via connect-mongo)
– Deployment environment (Render)
b. Relationships and interactions
– Client issues HTTP(S) requests to Express server (get pages, REST API calls).
– Server middleware authenticates/authorizes, validates inputs, invokes controllers.
– Controllers interact with Mongoose models to query or update MongoDB Atlas.
– Image uploads flow from client → Express (via Multer) → Cloudinary → stored URL in DB.
– Mapbox API calls happen client‑side to fetch map tiles/location data.
– OAuth flows redirect user to provider → callback to Express → user session created/stored.
– Session data stored in Mongo DB-backed store (connect-mongo); cookies maintained in client.
c. Architectural patterns and design principles
– MVC separation: Views (EJS), Controllers (controllers/), Models (models/).
– RESTful API for CRUD on listings, reviews, users.
– Layered architecture: routing → controller → data access.
– Middleware chain for cross‑cutting concerns: error handling, authentication, async wrap.
– Third‑party integrations kept modular (cloudConfig.js, Passport strategies).
d. Key technologies and libraries
– Express.js (routing, middleware)
– Mongoose (schema and data access)
– Passport.js (+ passport-local, passport-github, passport-google-oauth) for auth
– Joi for input validation
– Multer for file uploads
– Cloudinary SDK for image storage
– Mapbox JS API on front‑end
– EJS for server‑side templating