A modern, feature-rich travel app designed to enhance your travel experience with ease and convenience.
- Motivation
- Build Status
- Code Style
- Screenshots
- Tech/Framework Used
- Features
- Code Examples
- Installation
- API References
- Tests
- How to Use
- Contribute
- Credits
- License
Travel planning should be simple, intuitive, and enjoyable. Very Good Travel App was built to provide tourists and travel enthusiasts with tools to book activities, itineraries, and flights, share experiences, and explore destinations seamlessly.
This project is currently under development and is not suitable for production use, it is however built successfully
-
Navigation Challenges:
Users find it difficult to navigate the site due to an unintuitive layout and menu system. -
Inadequate Error Handling:
Missing or unclear error messages confuse users when something goes wrong (e.g., failed bookings or API errors). -
Accessibility Barriers:
The site lacks important accessibility features (e.g., screen reader support, keyboard navigation), making it unusable for some users.
We are actively working on addressing these issues, adding more automated tests, and expanding the documentation in future updates.
We follow industry best practices using the ESLint for linting.
- A view of the homepage with featured destinations.*
A view of the homepage with featured destinations.*
- A view of the homepage with featured destinations.*
- A view of the homepage with featured destinations.*
- A view of the homepage with featured destinations.*
- A view of the homepage with featured destinations.*
- A view of the homepage with featured destinations.*
- A view of the homepage with featured destinations.*
- A demo video of the website * Watch the video
- Node.js – JavaScript runtime for building scalable network applications.
- Express.js – Web framework for Node.js to build web applications and APIs.
- Mongoose – MongoDB object modeling tool for Node.js.
- bcrypt – Library to hash passwords.
- jsonwebtoken (JWT) – Library to generate JSON Web Tokens for secure authentication.
- dotenv – Module to load environment variables from a
.envfile. - nodemailer – Module for sending emails from Node.js.
- multer – Middleware for handling file uploads in Node.js.
- node-cron – Task scheduler for running cron jobs in Node.js.
- stripe – Library for integrating Stripe payments.
- Amadeus APIs – A set of APIs for accessing travel-related services, including flight and hotel bookings, and more.
- React.js – JavaScript library for building user interfaces.
- React Router – Routing library for React applications.
- Axios – Promise-based HTTP client for the browser and Node.js.
- Stripe React Library – React bindings for integrating Stripe’s payment system.
- FontAwesome – Library for scalable vector icons.
- @react-google-maps/api – Library for integrating Google Maps in React applications.
- React Scripts – Set of scripts for building and running React applications.
- cross-env – Package to set environment variables in scripts across different OS.
The website offers the following features for Tourists:
• Login using a username and password. • Change password securely. • Recover a forgotten password via OTP sent to email. • Create, read, and update a seller profile, including name and description, upon acceptance into the system. • Upload a profile picture. • Accept terms and conditions upon registration or system updates. • Request account deletion from the system.
• Update profile information, including wallet details. • Set vacation preferences (e.g., historic areas, beaches, budget-friendly options, etc.).
• Search for specific museums, historical places, activities, or itineraries by name, category, or tags. • Choose preferred currency to view prices.
• Book flights, hotels, and transportation through third-party applications. • Book tickets for events, activities, or itineraries directly on the platform. • Pay for bookings using:
- Credit card or debit card (via Stripe integration).
- Wallet balance (if available). • Cancel bookings up to 48 hours before the start of the event/activity or itinerary. • View the refunded amount from cancellations in the wallet. • Receive payment receipts via email.
• View and manage:
- Upcoming activities and itineraries.
- Past activities and itineraries (history). • Bookmark and save events for later viewing. • Receive notifications about:
- Upcoming bookings via email or in-app.
- Events of interest starting their booking phase. • Share activities, museums, historical places, or itineraries via email or copy link.
• Rate and comment on:
- Tour guides after completing a tour.
- Itineraries created by tour guides.
- Events or activities attended.
• Earn loyalty points upon payments for events/itineraries. • Redeem points as cash into the wallet. • Receive badges based on user level.
• Save products to a wishlist for future reference. • Add or remove items from the cart. • Modify quantities of items in the cart. • Checkout and pay using:
- Wallet balance.
- Credit card (via Stripe).
- Cash on delivery. • View current and past orders. • Rate and review purchased products.
• File complaints with details like title, body, and date. • Track complaint statuses (pending/resolved).
• Receive promo codes (e.g., birthday discounts) via email and in-app. • Use promo codes for purchases across the platform.
• Add new products with the following details:
- Name
- Price
- Description
- Available quantity • Upload product images. • Edit product details, including price and description. • Archive and unarchive products as needed.
• View available quantity and sales data for each product. • Receive notifications via email and system alerts when a product goes out of stock.
• View a detailed sales report containing revenue data. • Filter sales reports by product, date, or month.
• Provide a list of all available products, including:
- Product images
- Prices
- Descriptions
- Ratings and reviews • Search for products based on their names. • Filter products by price. • Sort products by ratings.
• Create, read, update, and delete itineraries with detailed information, including:
- Activities included in the itinerary.
- Locations to be visited.
- Timeline and duration of each activity.
- Language of the tour.
- Price of the tour.
- Available dates and times.
- Accessibility options.
- Pickup/drop-off locations. • Activate or deactivate itineraries with existing bookings. • Create, read, update, and delete tourist-specific itineraries for a defined date range, including tags and all associated details.
• Receive system notifications when:
- An event or itinerary is flagged as inappropriate by an admin. • Receive email notifications for flagged events or itineraries.
• View a sales report containing revenue details for itineraries and activities. • Filter sales reports by:
- Activity
- Itinerary
- Date
- Month • View reports on the total number of tourists who:
- Used an itinerary.
- Attended an activity. • Filter the total number of tourist reports by month.
• Create, read, and update a profile with detailed information, including:
- Link to the company website.
- Hotline.
- Company profile.
- Other relevant details (if accepted as an advertiser on the system).
• Upload a company logo or related image.
• Accept the terms and conditions upon account approval or updates.
• Request account deletion from the system.
• Create, read, update, and delete activities with comprehensive details, such as:
- Date and time of the activity.
- Location (integrated with Google Maps).
- Price or price range.
- Category, tags, and any special discounts.
- Whether bookings are open or closed.
• Create, read, update, and delete Transportations with comprehensive details, such as:
- Date and time of the Transportation.
- Pickup Location.
- DropOff Location.
- Price.
• View a sales report containing all revenue generated through activities.
• Filter sales reports by:
- Activity.
- Date.
- Month.
• View reports detailing the total number of participants or tourists attending activities.
• Filter participant reports by month.
• Receive system notifications when:
- An activity is flagged as inappropriate by the admin.
• Receive email notifications for flagged activities.
• Access a list of all created activities, transportations.
The website offers the following features for the Tourism Governor:
• Change account password.
• Recover password using an OTP sent to the registered email.
• Create, read, update, and delete museums and historical places with comprehensive details, including:
- Description of the place.
- Pictures.
- Location (with Google Maps integration).
- Opening hours.
- Ticket prices.
• Create tags for different historical locations based on attributes such as:
- Type (e.g., museum, cultural landmark).
- Historical period (e.g., Medieval, Renaissance).
• Change account password.
• Recover password using an OTP sent to the registered email.
• Add new Tourism Governors and Admins to the system by creating a unique username and password.
• View documents uploaded by *Tour Guides, **Advertisers, and *Sellers during registration.
• Accept or reject registration requests for *Tour Guides, **Advertisers, and *Sellers based on uploaded documents.
• Delete user accounts off the system.
• Flag an event or itinerary deemed inappropriate.
• View a list of all complaints issued along with their statuses (pending/resolved).
• View the details of a selected complaint.
• Mark complaints as pending or resolved.
• Reply to complaints issued by users.
• Sort complaints by date.
• Filter complaints by their status.
• View a list of all available products, including:
- Product details (picture, price, description, ratings, and reviews).
- Available quantity and sales of each product.
• Add products with their details (price, description, available quantity).
• Upload product images.
• Edit product details and pricing.
• Archive or unarchive products.
• Receive notifications when products are out of stock on the system (both in the system and via email).
• View a sales report containing all revenue generated from:
- Events.
- Itineraries.
- Gift shop sales.
• Filter sales reports based on a product, date, or month.
• View total registered users and the number of new users added per month.
• Create, read, update, and delete activity categories such as:
- Food.
- Stand-up comedy.
- Concerts.
- Parties.
- Exhibitions.
- Sports matches/events.
- Parks.
• Create, read, update, and delete preference tags, including: - Historic areas.
- Beaches.
- Family-friendly.
- Shopping.
- Budget-friendly.
• Create promotional codes for discounts on events, itineraries, or products.
const createTourist = async (req, res) => {
try {
// Destructure the request body to get user details
const { name, email, password, mobile, nationality, dob, job} = req.body;
// Create a new user instance with the role of tourist
const newUser = new Tourist({
name,
email,
password,
mobile,
nationality,
dob,
job
// No need to set bookedItineraries, createdItineraries, or wallet; they will default to appropriate values
});
// Save the user to the database
await newUser.save();
// Send success response
res.status(200).json({
message: 'Tourist created successfully',
tourist: {
id: newUser._id,
name: newUser.name,
email: newUser.email,
mobile: newUser.mobile,
nationality: newUser.nationality,
dob: newUser.dob,
job: newUser.job,
}
});
} catch (error) {
// Handle errors
console.error(error);
res.status(400).json({
message: 'Error creating tourist',
error: error.message
});
}
};
const getTourist = async (req, res) => {
try {
const users = await Tourist.find(); // Fetch all users from the database
res.status(200).json({
message: 'Users retrieved successfully',
data: users
});
} catch (error) {
console.error(error);
res.status(500).json({
message: 'Error retrieving users',
error: error.message
});
}
};router.get('/', getTourist)
router.post('/', createTourist)const touristRoutes = require('./routes/tourists')
app.use('/api/tourists', touristRoutes)// Function for the registration of a tourist
const registerTourist = async (touristData) => {
try {
const response = await fetch('http://localhost:4000/api/tourists', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(touristData),
});
const data = await response.json();
if (response.ok) {
console.log('Tourist registered successfully:', data);
return data;
} else {
console.error('Error during registration:', data);
return null;
}
} catch (error) {
console.error('Network or server error:', error);
return null;
}
}; // Handle tourist registration
if (role === "tourist") {
let touristData = {
name: formElements.username.value,
email: formElements.email.value,
password: formElements.password.value,
mobile: formElements.mobile.value,
dob: formElements.dob.value,
nationality: formElements.nationality.value,
job: formElements.job.value,
};
await registerTourist(touristData);
navigate("/tourist");
}To get started with the project, follow the steps below to install and set up the backend and frontend.
Before installing, ensure that you have the following installed on your system:
###Backend
-
Clone the repository:
git clone https://github.com/Advanced-computer-lab-2024/Very-good.git
-
Navigate to the backend directory:
cd backend -
Install the dependencies:
npm install
-
Set up environment variables:
MONGO_URI=your-mongodb-uri JWT_SECRET=your-jwt-secret STRIPE_SECRET_KEY=your-stripe-secret-key [email protected] EMAIL_PASS="your password"
-
Start the server:
node server.js
###Frontend
-
Navigate to the frontend directory:
cd frontendTemp -
Install the dependencies:
npm install
-
Set up environment variables:
REACT_APP_GOOGLE_MAPS_API_KEY=your-google-maps-api-key REACT_APP_STRIPE_PUBLIC_KEY=your-stripe-public-key
-
Start the frontend:
npm start
router.get('/', getActivities);
// Endpoint to the backend controller that fetches all activities
router.get('/search', searchactivity);
// Endpoint to the backend controller that allows searching for an activity by name
router.get('/:id', getActivityById);
// Endpoint to fetch an activity by its ID
router.post('/', createActivity);
// Endpoint to the controller function that creates an activity
router.post('/addComment', addCommentToActivity);
// Endpoint to the backend controller function that allows adding a comment to an activity
router.post('/filterYassin', filterActivitiesyassin);
// Endpoint to a backend controller that filters activities based on some categoriesrouter.post('/', createAdmin);
// Endpoint to the backend controller that creates a new admin
router.get('/getadmintag', getTags);
// Endpoint to the backend controller that gets all tags
router.post('/createadmintag', createTag);
// Endpoint to the backend controller that creates a new tag
router.patch('/updateadmintag/:id', updateTag);
// Endpoint to the backend controller that updates an existing tag by ID
router.delete('/deleteadmintag/:id', deleteTag);
// Endpoint to the backend controller that deletes a tag by ID
router.put('/itinerary/:itineraryId/flag', flagItinerary);
// Endpoint to the backend controller that handles flagging/unflagging an itinerary
router.get('/', getAdmins);
// Endpoint to the backend controller that fetches all admins
router.get('/getUserStatistics', getUserStatistics);
// Endpoint to the backend controller that handles statistics on numbers of usersrouter.get('/', getAdvertisers);
// Endpoint to the backend controller that handles fetching all advertisers
router.get('/:id/activities', getActivitieswithAdvertiserId);
// Endpoint to the backend controller that fetches activities for an advertiser with a specific ID
router.delete('/:id/activities', deleteActivityById);
// Endpoint to the backend controller that deletes an activity with a specific ID
router.put('/:id/activities', updateActivityWithId);
// Endpoint to the backend controller that updates an activity with a specific ID
router.delete('/:id', deleteAdvertiser);
// Endpoint to the backend controller that deletes an advertiser with a specific ID
router.post('/getAdvertiserByEmail', fetchAdvertiserByEmail);
// Endpoint to the backend controller that fetches an advertiser by email
router.post('/', createAdvertiser);
// Endpoint to the backend controller that handles creating a new advertiser
router.put('/updateAdvertiserByEmail', updateAdvertiserByEmail);
// Endpoint to the backend controller that updates an advertiser by email
router.put('/:advertiserId/accepted-terms', updateAcceptedTermsAndConditions);
// Endpoint to the backend controller that handles an advertiser accepting terms and conditions
router.post(
'/upload/:email',
uploadAdvertiser.fields([
{ name: 'IdDocument', maxCount: 1 },
{ name: 'taxationRegistryCard', maxCount: 10 }
]),
uploadDocuments
);
// Endpoint to the middleware and backend controller that handles advertiser document uploads
router.post(
'/uploadPhoto/:email',
uploadAdvertiser.single('photo'),
uploadPhoto
);
// Endpoint to the middleware and backend controller that handles advertiser photo uploads
router.post('/acceptadvertisers', acceptAdvertiser);
// Endpoint to the backend controller that handles an admin accepting an advertiser
router.post('/rejectadvertisers', rejectadvertiser);
// Endpoint to the backend controller that handles an admin rejecting an advertiserrouter.post('/', bookingController.createBooking);
//EndPoint to the backend Controller that handles the act of tourist booking either an event or an itinerary
router.patch('/cancel/:bookingId', bookingController.cancelBooking);
// EndPoint to the backend Controller that handles Cancelling a booking
router.get('/:touristId', bookingController.getBookings);
//EndPoint to the backend Controller that fetches all the booking of the calling touristrouter.get('/:id', getCategoryById);
// Endpoint to the backend controller that fetches a category corresponding to the provided ID
router.get('/', getCategories);
// Endpoint to the backend controller that fetches all categories
router.post('/', createCategory);
// Endpoint to the backend controller that creates a new category
router.delete('/:id', deleteCategory);
// Endpoint to the backend controller that deletes a category corresponding to the provided ID
router.patch('/:categoryName', updateCategory);
// Endpoint to the backend controller that updates a category corresponding to the provided namerouter.post('/submit', submitComplaint);
// Endpoint to the backend controller that handles the act of a tourist submitting a complaint
router.get('/my-complaints', getComplaintsForTourist);
// Endpoint to the backend controller that fetches complaints submitted by the calling tourist
router.get('/', getComplaints);
// Endpoint to the backend controller that fetches all complaints
router.get('/:id', getComplaintById);
// Endpoint to the backend controller that fetches a complaint corresponding to the provided ID
router.put('/:complaintId/status', updateComplaintStatus);
// Endpoint to the backend controller that handles updating the status of a complaint corresponding to the provided complaint ID
router.put('/:complaintId/reply', replyToComplaint);
// Endpoint to the backend controller that handles an admin replying to a complaint corresponding to the provided complaint IDrouter.get('/:id', getInfoByOfferId);
// Endpoint to the backend controller that fetches the information of an offer corresponding to the provided ID
router.get('/', getAllFlightInfo);
// Endpoint to the backend controller that fetches all flights informations
router.post('/', createFlightInfo);
// Endpoint to the backend controller that handles the creation of new flight informationrouter.get('/:id',getFlightOfferById);
//EndPoint to the backend Controller that handles fetching a specific instance of the flightoffer by id passed as parameter
router.get('/', getAllFlightOffers);
//EndPoint to the backend Controller that handles fetching all instances of flightoffers
router.post('/', createFlightOffer);
//EndPoint to the backend Controller that handles creatingrouter.get('/', getHistoricalPlaces);
// Endpoint to the backend controller that fetches all historical places
router.get('/:id', getMuseumByID);
// Endpoint to the backend controller that fetches a museum that corresponds to the passed ID
router.get('/:id/tags', getHistoricalPlaceTags);
// Endpoint to the backend controller that fetches tags of a historical place corresponding to the passed ID
router.post('/', createHistoricalPlace);
// Endpoint to the backend controller that handles creating a new historical place
router.delete('/:id', deleteHistoricalPlace);
// Endpoint to the backend controller that handles deleting a historical place corresponding to the passed ID
router.put('/:id', updateHistoricalPlace);
// Endpoint to the backend controller that handles updating a historical place corresponding to the passed ID
router.post('/filterByTag', FilterMuseumByTagName);
// Endpoint to the backend controller that filters museums according to the tag name
router.get('/search', searchforHP);
// Endpoint to the backend controller that handles searching for historical placesrouter.get('/:id',getHotelInfoByOfferId);
//EndPoint to the backend Controller that handles fetching a specific Hotel by id passed as a parameter
router.get('/', getAllHotelInfo);
//EndPoint to the backend Controller that handles fetching all instances of Hotels info
router.post('/', createHotelInfo);
//EndPoint to the backend Controller that handles creating an instance of a hotel info , with the data being sent in the request body router.get('/:id',getHotelOfferById);
//EndPoint to the backend Controller that handles fetching a specific Hotel offer by id passed as a parameter
router.get('/', getAllHotelOffers);
//EndPoint to the backend Controller that handles fetching all instances of HotelOffers
router.post('/', createHotelOffer);
//EndPoint to the backend Controller that handles creating a hotel offer with the data being sent in the request bodyrouter.get('/', getItineraries)
//EndPoint to the backend Controller that handles Fetching all instances of the itineraries
router.get('/search', searchforitinerary)
//EndPoint to the backend Controller that handles searching for a specific itineary , where the data is sent in the request body
router.get('/:id', getItineraryByID)
//EndPoint to the back Controller that handles fetching a specific itinerary , specified by the id passed as a parameter
router.post('/', createItinerary)
//EndPoint to the backend Controller that handles creating an instance of an itinerary with the data sent in the rq body
router.patch('/:id/status', itinerary_status)
//EndPoint to the backend Controller that handles setting the status of an itineray , specifed by the id sent as a parameter
router.post('/addComment',addCommentToItinerary);
//EndPoint to the backend Controller that handles adding a comment to an itinerary , specifed by the id sent in the request body
router.post('/filter', filterItinerariesYassin)
//EndPoint to the backend Controller that handles filtering itineraries , with the data specified in the req body
router.patch('/:id/flag', flagItinerary);
//EndPoint to the backend Controller that handles , flaging a specific itinerary specified by the id sent as a parameterrouter.post("/", loginUser);
//EndPoint to the backend Controller that handles , the act of login , with the parameters passed in the request body
router.post("/forgetPassword", forgotPasswordHandler);
//EndPoint to the backend Controller that handles , the act of user forget password , with the parameters passed in the request body
router.post("/verifyOTP", verifyOTPHandler);
//EndPoint to the backend Controller that handles , verification, with the parameters passed in the request body
router.post("/resetPassword", resetPasswordHandler);
//EndPoint to the backend Controller that handles , reseting the password, with the parameters passed in the request body router.post('/', notificationController.createNotification);
//EndPoint to the backend Controller , that handles creating a new instance of a notification
router.get('/:targetType/:targetId', notificationController.getNotifications);
//EndPoint to the backend Controller , that handles fetching a specific instance of a notfication specified by the id passed as a parameter
router.patch('/:id', notificationController.markAsRead);
//EndPoint to the backend Controller , that handles marking a specific instance of a notification as read , specified by the id passed as a parameter
router.delete('/:id', notificationController.deleteNotification);
//EndPoint to the backend Controller , that handles deleting a specific instance of a notifications , specified by the id passed as a parameterrouter.post('/', orderController.createOrder);
//EndPoint to the backend Controller that handles creating an instance of an order
router.get('/', orderController.getAllOrders);
//EndPoint to the backend Controller that handles retrieving all instances of orders
router.get('/:orderId', orderController.getOrderById);
//EndPoint to the backend Controller that fetches a specific order , specifed by the id passed as a paarameter
router.patch('/:orderId', orderController.updateOrderStatus);
//EndPoint to the backend Controller that updates a specific order , specified by the id passed as a parameter
router.delete('/:orderId', orderController.deleteOrder);
//EndPoint to the backend Controller that deletes a specific order , specified by the id passed as a parametersomething the controller uses
const router = express.Router();
router.post('/uploadPhoto/:id',
uploadProduct.single('photo'),
uploadPhoto
);
//EndPoint to the middleware and the backend Controller that handles adding a photo to a specific product that is specified by the id sent as a parameter
router.get('/fetchproductNameandIDbyID/:productId',getProductNameById)
//EndPoint to the backend Controller that handles fetching a specific products name , specified by the id sent as a parameter
router.get('/', getProducts);
//EndPoint to the backend Controller that handles fetching all instances of products
router.get('/available', getavailableProducts);
//EndPoint to the backend Controller that handles fetching all availiable instances of products
router.get('/FetchTheEntireProductById/:productId',getfullproductbyid);
//EndPoint to the backend Controller that handles fetching a specific instance of a product , specified by the id sent as a parameter
router.patch('/:id/archive', archiveProduct);
//EndPoint to the backend Controller that handles archiving a specific product , specified by the product id sent as a parameter
router.patch('/:id/unarchive', unarchiveProduct);
//EndPoint to the backend Controller that handles unarchiving a specific product , specified by the product id sent as a parameter
router.post('/review',addReviewToProduct)
//EndPoint to the backend Controller that handles adding a review to a specific product , the id is sent in the request body
router.delete('/:sellerId/products', deleteProductsBySeller);
//EndPoint to the backend Controller that handles deleting a specific product , specified by the seller id of the seller that created said product
router.post('/', createProduct);
//EndPoint to the backend Controller that handles creating an instance of a product
router.get('/search', searchbyname);
//EndPoint to the backend Controller that handles searching for a product by its name
router.patch('/:sellerId/products/:productId', putProducts); // Update product route
//EndPoint to the backend Controller that handles updating a specific product , specified by product id and seller id sent as parameters
router.get('/filter', filterProductsByPrice);
//EndPoint to the backend Controller that handles filtering instances of products , categories sent thro the request bodyrouter.post('/', promoCodeController.createPromoCode);
//EndPoint to the backend Controller , that handles creating a new instance of a promoCode
router.get('/', promoCodeController.getAllPromoCodes);
//EndPoint to the backend Controller , that handles fetching all instances of a promoCode
router.get('/:promoCodeId', promoCodeController.getPromoCodeById);
//EndPoint to the backend Controller , that handles fetching a specific promoCode , specified by the id sent as a parameter
router.patch('/:promoCodeId', promoCodeController.updatePromoCode);
//EndPoint to the backend Controller , that handles updating a specific promoCode , specified by the id sent as a parameter
router.delete('/:promoCodeId', promoCodeController.deletePromoCode);
//EndPoint to the backend Controller , that handles deleting a specific promoCode , specified by the id sent as a parameterrouter.get('/', getSellers)
//EndPoint to the backend Controller that fetches all instances of sellers
router.post('/', createSeller)
//EndPoint to the backend Controller that handles creating an instance of the seller
router.post('/getSellerByEmail', fetchSellerByEmail);
//EndPoint to the backend Controller that fetches a specific instance of the seller specified by an email which is sent in the request body
router.put('/updateSeller', updateSeller);
//EndPoint to the backend Controller that handles updating a specifc seller , specified by an email which is sent in the request body
router.delete('/:id', deleteSeller);
//EndPoint to the backend Controller that handles deleting a specific seller , specified by the id which is passed as a parameter
router.put('/:sellerId/accepted-terms', updateAcceptedTermsAndConditions);
//EndPoint to the backend Controller that handles the action of accepting terms and conditions for the calling instance of seller
router.post('/upload/:email',
uploadSeller.fields([
{ name: 'IdDocument', maxCount: 1 },
{ name: 'taxationRegistryCard', maxCount: 10 }
]),
uploadDocuments
);
//EndPoint to the middleware and backend Controller that handles the act of the specified seller uploading documents , the seller is identified by the passed as a parameter email
router.post('/uploadPhoto/:email',
uploadSeller.single('photo'),
uploadPhoto
);
//EndPoint to the middleware and backend Controller that handles the act of the specified seller uploading a logo , the seller is identified by the passed as a parameter email
router.post('/acceptsellers', acceptsellers);
//EndPoint to the backend Controller that handles the act of an admin accepting a seller onto the system , the sellers email is passed in the request body
router.post('/rejectsellers',rejectsellers);
//EndPoint to the backend Controller that handles the act of an admin rejecting a seller onto the system , the sellers email is passed in the request body
router.post('/fetchproductsforSpecificSeller/:email',fetchProductsBySellerEmail)
//EndPoint to the backend Controller that handles fetching Products created by a specific seller , specified by the email passed as a parameterrouter.post('/create-payment-intent', createPaymentIntent);
//EndPoint to the backend Controller that creats a payement intentrouter.get('/', getTags);
//EndPoint to the backend Controller that handles fetching all instances of tags
router.post('/create', createTag);
//EndPoint to the backend Controller that handles creating an instance of a tag
router.patch('/update/:id', updateTag);
//Endpoint to the backend Controller that updates a specific tag instance , which has an id corresponding to the one sent as a parameter
router.delete('/deletee/:id', deleteTag);
//EndPoint to the backend Controller that handles deleting a specific instance of a tag that corresponds to the id sent as a parameter
router.get('/tags/names', getAllTagNames);
//EndPoint to the backend Controller that fetches All tags Names router.get('/', getTourGuides)
//EndPoint to the backend Controller that handles fetching all instances of tourGuides
router.get('/:id/itineraries', getItinerarieswithTourGuideId)
//EndPoint to the backend Controller that handles fetching a specific instance of a TourGuide That corresponds to the id passed as a parameter
router.delete('/:id/itineraries', deleteItineraryById);
//EndPoint to the backend Controller that handles deleting a specific instance of an itineray That corresponds to the id passed as a paramter
router.put('/:id/itineraries', updateItineraryWithId);
//EndPoint to the backend Controller that handles updating a specific instance of an itineray That corresponds to the id passed as a paramter
router.post('/', createTourGuide)
//EndPoint to the backend Controller that handles creating an instance of a tourguide
router.put('/:tourGuideId/accepted-terms', updateAcceptedTermsAndConditions);
//EndPoint to the backend Controller that handles accepting the terms and condition of a tourguide That corresponds to the id passed as a parameter
router.post('/getByEmail',getTourGuideByEmail)
//EndPoint to the backend Controller that handles fetching a specific tourguide that has an email corresponding to the one sent in the request body
router.delete('/:id', deleteTourGuide);
//EndPoint to the backend Controller that handles deleting a specific instance of a tourGuide which has an id equal to the one passed as a parameter
router.post('/upload/:email',
uploadTourGuide.fields([
{ name: 'IdDocument', maxCount: 1 },
{ name: 'certificatesDocument', maxCount: 10 }
]),
uploadDocuments
);
//EndPoint to the middleware and backend Controller handling the action of uploading a document for the calling instance of the tourguide , that has an email equal to the one passed as a parameter
router.post('/uploadPhoto/:email',
uploadTourGuide.single('photo'), // Only one file named 'photo'
uploadPhoto // Controller function to handle storing the photo URL in the database
);
//EndPoint to the middleware and backend Controller handling the action of uploading a picture for the calling instance of the tourguide , that has an email equal to the one passed as a parameter
router.post('/addComment', addCommentToTourGuide)
//EndPoint to the backend Controller that handles adding a comment to the tourguide whos id is sent in the request body
router.post('/accept-tour-guide', acceptTourGuide);
//EndPoint to the backend Controller that handles a tourguide being accepted on the system by an admin , the tourguide id is sent in the request body
router.post('/reject-tour-guide',rejectTourGuide);
//EndPoint to the backend Controller that handles a tourguide being rejected on the system by an admin , the tourguide id is sent in the request body
router.put('/updateTourGuideByEmail', updateTourGuideByEmail);
//EndPoint to the backend Controller that handles updating the information of a specific tourguide instance, the email alongside data updates are sent in the request bodyrouter.get('/', getTourismGoverners);
//EndPoint to the backend Controller that handles fetching all instances of tourismGoverners
router.post('/', createTourismGoverner);
//EndPoint to the backend Controller that creats an instance of tourismGoverner
router.put('/updateByEmailTourism', updateRecordsTourism);
//EndPoint to the backend Controller that handles updating a specific tourism governer instance , specified by an email sent in the request body
router.delete('/:id', deleteTourismGoverner);
//EndPoint to the backend Controller that handles deleting a specific tourism governer , specified by the id passed as a parameter router.get('/', getTourist)
//EndPoint to the backend Controller that fetches all tourists
router.delete('/deleteAll', deleteAllTourists);
//EndPoint to the backend Controller that deletes all tourists of the system
router.get('/:id', getTouristById);
//EndPoint to the backend Controller that fetches a specific tourist according to the passed id
router.post('/addProductToCart',addProductToCard)
//EndPoint to the backend Controller that handles adding a product to a tourist`s cart
router.post('/removeProductWishList',removeProductFromWishlist)
//EndPoint to the backend Controller that handles removing a product from a tourist`s whishlist
router.post('/getWishList',getWishlistProducts)
//EndPoint to the backend Controller that handles fetching all the products in the calling tourist`s wishlist
router.post('/addProductToWishList',addProductToWishlist)
//EndPoint to the backend Controller that adds a product to the calling Tourist`s wishlist
router.patch('/:id/bookTransportation', bookTransportation);
//EndPoint to the backend Controller that handles the action of booking a transportation for the tourist with the corresponding passed id
router.post('/', createTourist)
//EndPoint to the backend Controller that handles creating a new tourist
router.post('/getByEmail' ,getTouristByEmail);
//EndPoint to the backend Controller that fetches a specific tourist according to the email corresponding to the one sent in the request body
router.post('/updateByEmail',updateRecords);
//EndPoint to the backend Controller that handles updating a tourist that has an email corresponding to the one sent in the request body
router.delete('/:id', deleteTourist);
//EndPoint to the backend Controller that deletes a tourist which has an id equal to the one passed as a parameter
router.post('/past-itineraries', getPastItinerariesWithTourGuides);
//EndPoint to the backend Controller that handles fetching all past itineraries with their tourguide data
router.post('/past-itineraries2', getPastItinerariesWithTourGuidesForCommentOnItenrary);
//EndPoint to the backend Controller that fetches again all past itineraries with their tourguide data , used for commenting on an itineray
router.post('/past-activities',getPastBookedActivities)
//EndPoint to the backend Controller that fetches all past activities of the calling tourist
router.put('/:userId/book-flight-offer/:offerId', addFlightOfferToTourist);
//EndPoint to the backend Controller that handles adding a flight booking to the tourist with the corresponding id sent as a parameter
router.put('/:userId/book-hotel-offer/:offerId', addHotelOfferToTourist);
//EndPoint to the backend Controller that handles adding a hotel booking to the tourist with the corresponding id sent as a parameter
router.post('/purchase', purchaseProductbck);
//EndPoint to the backend Controller that handles the action of a tourist purchasing a product
router.get('/purchased', getPurchasedProducts);
//EndPoint to the backend Controller that fetches all purchased products of the calling tourist
router.patch('/rate/', rateProduct);
//EndPoint to the backend Controller that handles the action of the calling tourist rating a purchased product
router.patch('/rate-tour-guide', rateTourGuide);
//EndPoint to the backend Controller that handles the action of the calling tourist rating a tourguide
router.patch('/rate-itinerary', rateItinerary);
//EndPoint to the backend Controller that handles the action of the calling tourist rating an itinerary
router.patch('/rate-activity', rateActivity);
//EndPoint to the backend Controller that handles the action of the calling tourist rating an activity
router.post('/:id/make-payment', makePayment);
//EndPoint to the backend Controller that handles subtracting from the wallet or using the credit card for the tourist with an id equal to the one passed as parameter when purchasing a product
router.post('/:id/redeem-points', redeemPoints);
//EndPoint to the backend Controller that handles the act of the tourist with the passed id as a parameter , to redeem gained points
router.post('/:id/make-payment2', makePayment2);
//EndPoint to the backend Controller that handles subtracting from the wallet or using the credit card for the tourist with an id equal to the one passed as parameter when purchasing a product
router.get('/:email/itineraries', getItinerariesForTourist);
//EndPoint to the backend Controller that fetches all itineraries booked by the tourist whos email is sent as a parameter
router.get('/:email/activities', getActivitiesForTourist);
//EndPoint to the backend Controller that fetches all activities booked by the tourist whos email is sent as a parameter
router.post('/bookmark-activity', bookmarkActivity);
//EndPoint to the backend Controller that handles adding an activity to the calling tourist bookmarked array
router.post('/getBookmarkedActivities', getBookmarkedActivities);
//EndPoint to the backend Controller that fetches all bookmarked activities
router.post('/:touristId/add-delivery-address', addDeliveryAddress);
//EndPoint to the backend Controller that adds a deliveryAddress to the tourist whos id is sent as a parameter
router.get('/:touristId/get-delivery-addresses', getDeliveryAddresses);
//EndPoint to the backend Controller that fetches all deliveryAddresses of the tourit whos id is sent as a parameter
router.post('/:touristId/orders-create-view',CreateAndReturnOrderArray)
//EndPoint to the backend Controller that handles creating and viewing of an order of the tourist whos id is equal to the one passed as a parameter
router.post('/:touristId/ordersView',viewOrders)
//EndPoint to the backend Controller that views all orders of the tourist whos id is equal to the one passed as a parameter and their status
router.delete('/:touristId/orders/:orderId', deleteOrder);
//EndPoint to the backend Controller that deletes an order of the tourist whos id is equal to the one passed as a parameter
router.get('/:touristId/cart', viewCart);
//EndPoint to the backend Controller that views the cart of the tourist whos id is equal to the one passed as a parameter
router.delete('/:touristId/cart/:productId', removeProductFromCart);
//EndPoint to the backend Controller that removes an item from the cart of the tourist whos id is equal to the one passed as a parameterrouter.get('/advertiser/:advertiserId', getTransportationsByAdvertiserId)
//EndPoint to the backend Controller that handles fetching An instance of transportations that have a corresponding AdvertiserId ,eequal to the one passed as a parameter
router.get('/:id', getTransportationById)
//EndPoint to the backend Controller that handles fetching a specific transportation which has an id equal to the one passed as a parameter
router.get('/', getAllTransportations)
//EndPoint to the backend Controller that handles fetching all transportation instances
router.post('/', createTransportation)
//EndPoint to the backend Controller that handles creating an instance of a transportation
router.post('/getWithLocation', getTransportationsWithLocation)
//EndPoint to the backend Controller that handles fetching transportations with their location
router.put('/:id', editTransportation);
//EndPoint to the backend Controller that handles editing a transportation whos id corresponds to the one sent as a parameter
router.delete('/:id', deleteTransportation);
//EndPoint to the backend Controller that handles deleting a transportation whos id corresponds to the one sent as a parameterScreenShot of postman where we test the API route get http://localhost:4000/api/products/ , that should return an instance of all products (fetching all products , takes no parameters and no body )
ScreenShot of postman where we test the API route post http://localhost:4000/api/products/ , that should return a success message in the response body (creating a product , takes a json body )
ScreenShot of postman where we test the API route patch http://localhost:4000/api/products/672d71cb7b921bfd1bbe84de/archive ,that should return the product and a success message after being Archived (archiving a product , takes the product id as a parameter in the link )
This guide explains how to use the system from the perspective of each stakeholder type. Follow the step-by-step instructions to utilize the platform effectively.
-
Register and Log In (Except for Admins and Tourism Governors)
- Navigate to the website and click "Sign Up" to create an account.
- Select your role (Tourist, Tour Guide, Advertiser, Seller) and fill in the required details.
- Log in using your credentials.
-
Log In Only (For Admins and Tourism Governors)
- Admins and Tourism Governors are added to the system by an Admin.
- Use the provided credentials to log in directly.
-
Forgot Password
- If you forget your password, click "Forgot Password" on the login page.
- Enter your registered email to receive password reset instructions.
-
Navigate the Sidebar
- Use the sidebar to access:
- Comment: View and add comments to activities or itineraries.
- Rate: Provide ratings for activities, museums, or itineraries.
- Book a Flight: Search for and book flights.
- View My Booked Flights: Access details of your booked flights.
- Book a Transportation: Search for and book transportation options.
- View My Booked Transportations: Access details of your booked transportation.
- Book Itineraries/Activities: Select and book itineraries or activities.
- View My Cart: Check items saved for later booking or purchase.
- View My Orders: Access details of products or services purchased.
- Use the sidebar to access:
-
Browse and Search
- Use the homepage to explore featured activities, museums, and historical places.
- Click the search bar or apply filters (e.g., location, price) to refine your search.
- Access your itineraries, activities, and products directly from the homepage.
-
Make a Booking
- Select an activity, transportation, or product and click "Book Now."
- Fill in the required details such as date, number of participants, and payment information.
- Confirm the booking and check your "My Bookings" section for details.
-
Share Experiences
- Click the "Share" button on an activity or itinerary page to copy a link or send it via email.
- Add comments and reviews after participating in activities.
-
Sign Up and Submit Documents
- Create an account and select "Tour Guide" as your role.
- Upload required documents like ID and certifications for verification.
-
Profile Setup
- Once approved, log in and complete your profile by adding your bio, expertise, and photos.
-
Create Itineraries
- Navigate to the "Itineraries" section and click "Create New."
- Add details such as title, description, activities, and schedule.
- Save or publish the itinerary to make it visible to tourists.
-
Manage Bookings
- View bookings from tourists in the "My Bookings" dashboard.
- Respond to inquiries and confirm or modify bookings as needed.
-
Log In to the Dashboard
- Access the admin portal using your credentials.
-
Manage Tags
- Create, edit, or delete tags that can be associated with activities, museums, or historical places.
-
Manage Historical Places and Museums
- Use the "Manage Content" section to add, update, or remove details of museums and historical places, including descriptions, locations, ticket prices, and photos.
-
Account Management
- Log in to the system using your credentials.
- Navigate to the "Users" section to:
- Change your account password.
- Recover a forgotten password using an OTP sent to the registered email.
- Add new Tourism Governors and Admins by creating a unique username and password for them.
-
User and Content Moderation
- Access the "Moderation" section to:
- View documents uploaded by Tour Guides, Advertisers, and Sellers during registration.
- Accept or reject registration requests based on the uploaded documents.
- Delete user accounts from the system if necessary.
- Flag inappropriate events or itineraries.
- Access the "Moderation" section to:
-
Complaint Management
- Open the "Complaints" section to:
- View all complaints along with their statuses (pending/resolved).
- View details of a specific complaint.
- Mark complaints as pending or resolved.
- Reply to complaints submitted by users.
- Sort complaints by date or filter them by status.
- Open the "Complaints" section to:
-
Product Management
- Navigate to the "Products" section to:
- View a list of all available products, including their details (picture, price, description, ratings, reviews, available quantity, and sales).
- Add new products with relevant details.
- Upload product images.
- Edit product details and pricing.
- Archive or unarchive products.
- Receive notifications (both in the system and via email) when products are out of stock.
- Navigate to the "Products" section to:
-
Reporting and Analytics
- Access the "Reports" section to:
- View sales reports for events, itineraries, and gift shop sales.
- Filter reports by product, date, or month.
- View total registered users and new users added per month.
- Access the "Reports" section to:
-
Activity and Tag Management
- Manage categories and tags by:
- Creating, reading, updating, and deleting activity categories (e.g., Food, Concerts, Parks).
- Creating, reading, updating, and deleting preference tags (e.g., Historic Areas, Family-friendly).
- Manage categories and tags by:
-
Promotions Management
- Navigate to the "Promotions" section to create promotional codes for discounts on events, itineraries, or products.
-
Account and Profile Management
- Register as an advertiser and log in.
- Navigate to the "Profile" section to update your account details, including:
- Company website link.
- Hotline and other contact information.
- Company profile details.
- Upload a company logo or relevant image.
- Accept terms and conditions when updating your profile or after account approval.
- Request account deletion via the "Profile" section if needed.
-
Activity Management
- Navigate to the "Activities" section to manage your activities:
- Click "Create New Activity" to add details such as:
- Date and time of the activity.
- Location (integrated with Google Maps).
- Price or price range.
- Category, tags, and special discounts.
- Status (open or closed for booking).
- View, update, or delete existing activities as needed.
- Click "Create New Activity" to add details such as:
- Navigate to the "Activities" section to manage your activities:
-
Transportation Management
- Navigate to the "Transportation" section to manage transport services:
- Click "Create New Transportation" to add details such as:
- Date and time of the service.
- Pickup and drop-off locations.
- Price.
- Update or delete existing transport services as required.
- Click "Create New Transportation" to add details such as:
- Navigate to the "Transportation" section to manage transport services:
-
Reporting and Analytics
- Access the "Reports" section to view performance metrics:
- View sales reports, including revenue generated from activities.
- Filter reports by activity, date, or month.
- Access participant reports detailing the number of tourists attending activities, with monthly filters.
- Access the "Reports" section to view performance metrics:
-
Notifications
- Check the "Notifications" section for system updates:
- Receive notifications for flagged activities.
- Access email alerts for flagged content.
- Check the "Notifications" section for system updates:
-
View and Manage Content
- Access a complete list of created activities and transport services in the "Manage Content" section.
- Use filters and search tools to find specific entries.
-
Product Management
- Add new products with the following details:
- Name
- Price
- Description
- Available quantity
- Upload product images.
- Edit product details, including price and description.
- Archive and unarchive products as needed.
- Add new products with the following details:
-
Inventory and Notifications
- View available quantity and sales data for each product.
- Receive notifications via email and system alerts when a product goes out of stock.
-
Sales and Revenue Reports
- View a detailed sales report containing revenue data.
- Filter sales reports by product, date, or month.
-
Product Discovery
- Provide a list of all available products, including:
- Product images
- Prices
- Descriptions
- Ratings and reviews
- Search for products based on their names.
- Filter products by price.
- Sort products by ratings.
- Provide a list of all available products, including:
- Always keep your profile and content updated for better visibility.
The app is far from perfect and would indeed benefit from the expertise of others , All you need to do to contribute in the development of this app is to follow the next simple steps :-
Obviously us as a team could have never been able to reach this point in the development of this app if it wasnt for our great staff of TAs
The license report for all dependencies in the frontendtemp folder can be found here.
The license report for all dependencies in the frontendtemp folder can be found here.