Carigo 🦌

A virtual trip planner to make your travels easier and help you book everything in one place

Table of Contents

• Motivation ✨
• Build Status 📋
• Code Style 💻
• Frameworks used 🛠️
• Features & Screenshots 📸
• Code Examples 🧩
• Installation 🔧
• API References 📚
• Tests ✅
• How to Use 📖
• Contribute 🤝
• Credits 🙏
• License 📜

Motivation

want to plan you next trip without gettign a major headache? with Carigo you can plan and book everything in your trip from activites near your destination to your plane tickets in one place!!

Build Status

this project is still under development and not publishable to the public

Code Style

the project is split among 2 folder

1. frontned this folder has everything related to the clients side and is split into
   • components: folder with most of the website front end componentns
   • Pages: folder that has all the .js files that are full pages on the website
     • some folders inside the pages folder have a sub components folder that has components specific to these folders
   • assets : this folder is used to hold any images used inside our frontend
2. backend this is where the server side is handled and it si split into a few main folders
   • controllers : this has the controllers for all the main elements of our project and where all the code for the API functions is written
   • routes : the folder that handles creating routes for all API functions created inside controllers
   • models : contains the database models for all pur database elements
   • middleware: used to hold the code for anu authentication procees required
   • public/img : a folder used to hold all the uploaded images / documents for admin approval
   • utils : contains functions that help controllers in things such as error checking and sending emails
   3. We use Prettier to enforce a consistent code style.

Useful Commands

Useful Commands

• Check formatting using Prettier

npm run format

• And then fix formatting using Prettier

npm run format:fix

## Screenshots

Frameworks-used

MERN stack

• MonogDB: MongoDB is used to host our server.
• Express: Express is used to interface our back and front ends.
• React: React.js is used to build our website frontend.
• Node: Node.js is used as our backend runtime environment in Javascript.
• postman : postman was used to test our routes before implementing them into frontend

Frontend Libraries

• Material UI (6.1.9): we use mui as alot of its built in components are easier to use than HTML
• joy : to validate user inputs
• basic HTML components
• jwt-decode: to decode user token to get user id when needed

Backend Libraries

• bcrypt: was used for hashing and unhashing of passwords and authentication perposes
• dotenv: to get data for the .env file to avoid exposing private keys
• node-schedule: was used for tasks that need scheduling like checking daily for birhdays and notifications
• nodemon: in order to recompile the code each time a modification was made

User Communication

• nodeMailer: was used to send emails

Payment

• stripe: was used to handle card payments
• exchangerate-api.com: was user for currency conversion

HTTP client

• Axios: to handle communication between frotend and backend

Features & Screenshots

book flights/hotels/transportations , look for activities , book itineraries with a tour guides or just find out about historical places in your next destination, and even see what souvnirs you want to buy all in one place !

filter through and scroll into endless choices of activites to add to oyur next trip!!

book detailed iteneraries with trusted tour guides filled with exciting activities !

like an itinerary but it isnt open for booking yet? simply click notify me and our system will send you a reminder when it is open :)

or if something simply interests you for a later trip archive it for later

easily navigate through our website suing our simple side bar

visiting a new country? look through all the historical places you dont wanna miss!!

if you already have an account log in to be able to book anything

or if you are new to our website sign up either as a tourist or as any of advertiser,seller ,or tour guide

select your prefrences upon sign up to get your own personalised feed!!

look for any souvenir you want to buy on your trip via our gift shop 🎁

view your cart and check out all you tiems art once!!

visit your cool looking profile with all your information

navigate to your orders and view any past or current orders

also easily and smoothly manage your profile settings

now that the insides of your trip is planned there is still 1 more step!!
✨ transportation and accomodation ✨
book any flights 🛬 , hotels 🏨, or even in trip trnasportation 🚕 🚎 provided by our advertisers easily through our website!!

if you would like to join our website as ne of our advertisers,sellers and tour guides we have loads of diffrent features for you
In the advertiser profile you can create your own activities/transportaion

You can view your wonderful activities/transportation from Activity Post and the My Transportations buttons

As a tour guide you can navigate to your active/inactive Itineraries

The active itineraries

The inactive itineraries

Through the button "CREATE NEW ITINERARY" you can create another exciting itineraries

as a seller, view your profile and edit your personal details, receive a notification when your product is out of stock

a seller can add and manage products, sort them by ratings, filter and search their own products and archive or unarchive them

as a seller, get a sales report for your products which you can filter and download

as an admin, manage and edit everything smoothly with our easy to use admin home layout !

as an admin, manage accounts by clicking on the pencil icon and filling in the required fields

as an admin, accept or reject and download the docs of new users before they can access the website

as an admin you can view, sort, filter, search or add products to the gift shop!

as an admin you can view, edit, delete or add the categories used for events and places

as an admin you can view, edit, delete or add the preference tags used for historical events and places

as an admin, you can view the itineraries available on the website and approve them or mark them as appropriate

as an admin, you can view the activities available on the website

as an admin, you can view the complaints made by tourists and filter them by status of pending or resolved, and click on the Date header to sort them by date

by clicking on the complaint, you an reply to the complaint or toggle its status

as an admin, you an create promocodes to be used in any payment made on the website

as an admin, you can view a report of all the users on the website, you can select a user role below the chart to filter it out of the data or click download to download the report

as an admin, you can view and filter a sales report of all types of sales made on the website and click on the category names at the top to view their data isolated

Code Examples

Routes Example

const adminRouter = require("./routes/adminRouter.js");
const productRouter = require("./routes/productRouter.js");
const experienceRouter = require("./routes/experienceRouter");
const amadusRouter = require("./routes/amadusRouter.js");
const transportationRouter = require("./routes/transportationRouter.js");
const purchaseRouter = require("./routes/purchaseRouter.js");
const DeleteRequestRouter = require("./routes/deleteRequestRouter.js");
const notificationRoutes = require("./routes/notificationRouter.js");
const salesReportRouter = require("./routes/salesReportRouter.js");

Controller Example

const Tourist = require("./../models/User");
const catchAsync = require("./../utils/catchAsync");
const AppError = require("./../utils/appError");
const factory = require("./handlerFactory");

exports.getAllTourists = factory.getAllSpecificUsers("Tourist");

exports.getTourist = factory.getOne(Tourist, {});

const filterObj = (obj, ...allowedFields) => {
  const newObj = {};
  Object.keys(obj).forEach((el) => {
    if (allowedFields.includes(el)) newObj[el] = obj[el];
  });
  return newObj;
};

exports.getMe = (req, res, next) => {
  req.params.id = req.user.id;
  next();
};

exports.updateMe = catchAsync(async (req, res, next) => {
  // Give error if user POSTs password data
  if (req.body.password || req.body.passwordConfirm) {
    return next(
      new AppError(
        "This route is not for password updates. Please use /updateMyPassword. 🔑🚫",
        400
      )
    );
  }

  if (req.body.wallet) {
    return next(
      new AppError("You can't change your balance manualy. 🔑🚫", 400)
    );
  }

  // Filtered out unwanted fields names that are not allowed to be updated
  const filteredBody = filterObj(req.body, "username", "email");

  // Update user document
  const updatedTourist = await Tourist.findByIdAndUpdate(
    req.user.id,
    filteredBody,
    {
      new: true,
      runValidators: true,
    }
  );

  res.status(200).json({
    status: "success",
    data: {
      tourist: updatedTourist,
    },
  });
});

exports.deleteMe = catchAsync(async (req, res, next) => {
  await User.findByIdAndUpdate(req.user.id, { isActive: false });

  res.status(204).json({
    status: "success",
    data: null,
  });
});

exports.deleteTourist = catchAsync(async (req, res, next) => {
  await User.findByIdAndUpdate(req.params.id, { isActive: false });

  res.status(204).json({
    status: "success",
    data: null,
  });
});

Create Product Example

const createProduct = async (req, res) => {
  const userId = new mongoose.Types.ObjectId(req.body.author); // Convert to ObjectId
  const userType = await userModel.findOne({ _id: userId }); // Project only 'roles' field
  if (!userType) {
    return res.status(404).json({ message: "user not found" });
  }
  const role = userType.role.toLowerCase();
  console.log(role);
  if (role == "seller") {
    console.log("inside seller");
    const authorId = new mongoose.Types.ObjectId(req.body.author); // Convert to ObjectId
    const { name, picture, price, description, ratings, reviews, quantity } =
      req.body;
    try {
      const product = await productModel.create({
        author: authorId, // Use the ObjectId for author,
        name,
        picture,
        price,
        description,
        ratings,
        reviews,
        quantity,
      });
      res.status(200).json(product);
    } catch (error) {
      res.status(400).json({ error: error.message });
    }
  } else {
    return res.status(400).json({ error: "Invalid user type" });
  }
};

Model Example

const mongoose = require("mongoose");

const notificationSchema = new mongoose.Schema(
  {
    userId: {
      type: mongoose.Schema.Types.ObjectId,
      ref: "User",
      required: true,
    },
    message: {
      type: String,
      required: true,
    },
    type: {
      type: String,
      enum: [
        "flagged_content",
        "booking_opened",
        "upcoming_event",
        "out_of_stock",
        "promo_code",
      ],
      required: true,
    },
    contentId: {
      type: mongoose.Schema.Types.ObjectId,
      refPath: "contentModel",
    },
    contentModel: {
      type: String,
      enum: ["Itinerary", "Activity", "Product", "PromoCode"],
      required: function () {
        return this.contentId != null;
      },
    },
    isRead: {
      type: Boolean,
      default: false,
    },
    createdAt: {
      type: Date,
      default: Date.now,
    },
    scheduledFor: {
      type: Date,
    },
    emailSent: {
      type: Boolean,
      default: false,
    },
  },
  { timestamps: true }
);

notificationSchema.index({ userId: 1, createdAt: -1 });

const Notification = mongoose.model("Notification", notificationSchema);

module.exports = Notification;

user Validator Example

const catchAsync = require("../utils/catchAsync");
const AppError = require("../utils/appError");
const Joi = require("joi");

// Define Joi validation schemas for base user fields and each role
const baseUserValidationSchema = Joi.object({
  username: Joi.string().min(2).max(15).required().messages({
    "string.min": "Username must be at least 2 characters long.👤",
    "string.max": "Username must be at most 15 characters long. 👤",
    "any.required": "Username is a required field. 👤",
  }),
  email: Joi.string().email().required().messages({
    "string.email": "Please provide a valid email address. 📧",
    "any.required": "Email is a required field. 📧",
  }),
  password: Joi.string().min(6).required().messages({
    "string.min": "Password must be at least 6 characters long. ❌❗",
    "any.required": "Password is a required field.❌❗",
  }),
  passwordConfirm: Joi.any().valid(Joi.ref("password")).required().messages({
    "any.only": "Passwords do not match.❌❗",
    "any.required": "Password confirmation is a required field.❌❗",
  }),
  role: Joi.string()
    .valid(
      "Admin",
      "Tourist",
      "Tour_Guide",
      "Advertiser",
      "Seller",
      "Tourism_Governer"
    )
    .required()
    .messages({
      "any.only": "Role must be one of the following: Admin, Tourist, Tour Guide, Advertiser, Seller, Tourism Governer. 👤",
      "any.required": "Role is a required field. 👤",
    }),
});
})

authentication middelware Example

import { jwtDecode } from "jwt-decode";

const authenticateToken = (req, res) => {
  const authHeader = req.headers["authorization"];
  const token = authHeader && authHeader.split(" ")[1]; // Extract the token from the Authorization header

  if (!token) return res.sendStatus(401); // If there's no token, respond with 401

  jwt.verify(token, process.env.ACCESS_TOKEN_SECRET, (err, user) => {
    if (err) return res.sendStatus(403); // If token is invalid, respond with 403 Forbidden
    req.user = user; // Attach the user information to the request object
    // next(); // Call the next middleware or route handler
  });
};

exports.authenticateToken = authenticateToken;

list of all itineraries react example

import React from "react";
// import ReactDOM from "react-dom/client";
import "../styles/index.css";
import NavBar from "../components/NavBarTourist";
import { Box } from "@mui/material";
import ItineraryList from "../components/ItirenaryList";
import CreateActivityForm from "../components/CreateActivityForm";
import CreateItineraryForm from "../components/CreateItineraryForm";
import ListOfItineraries from "../components/ListOfItineraries";

const AllItineraries = () => {
  return (
    <div>
      <NavBar />
      <Box
        sx={{
          width: "1150px",
          overflow: "hidden",
          margin: "0 auto",
          padding: "20px",
          height: "80vh", // Set a fixed height for the scrolling area
          overflow: "auto", // Enable scrolling
          "&::-webkit-scrollbar": {
            display: "none", // Hides the scrollbar for WebKit browsers (Chrome, Safari)
          },
          //backgroundColor : "aquamarine" ,
        }}
      >
        <Box
          sx={{
            height: "100%",
            marginLeft: "100px",
            width: "100%",
            "&::-webkit-scrollbar": { display: "none" },
          }}
        >
          {" "}
          {/* Enable vertical scrolling only */}
          <ListOfItineraries />
        </Box>
      </Box>
    </div>
  );
};

export default AllItineraries;

app routing Example in react

function App() {
  return (
    //  <AuthProvider>
    <Router>
      <Routes>
        <Route path="/Tourist/orders" element={<OrderListScreen />} />
        <Route
          path="Tourist/order_detail/:id"
          element={<OrderDetailScreen />}
        />
        <Route path="/" element={<HomePageGuest />} /> {/* Default route */}
        <Route path="/tourist/MyBookings" element={<MyBookings />} /> {/* Default route */}
        <Route
          path="/tourist/MyBookedActivities"
          element={<MyBookedActivities />}
        />{" "}
        {/* Default route */}
        <Route
          path="/tourist/MyBookedTransportation"
          element={<MyBookedTransportation />}
        />
        <Route path="/tourist/MyBookedFlights" element={<MyBookedFlights />} />
        <Route path="/tourist/MyBookedHotels" element={<MyBookedHotels />} />
        <Route path="/login" element={<LoginPage />} />
      </Routes>
    </Router>
  );
}

Installation

• Make sure you have Node and Git installed

• Make a new folder for CariGo Trip Planner

mkdir CariGo
cd CariGo

• Clone this repo

git clone https://github.com/Advanced-computer-lab-2024/CariGo

• Install dependencies for CariGo backend

cd CariGo
cd backend
npm install

• Install dependencies for CariGo frontend

cd Carigo
cd frontend
npm install

then to run the website

first use the command

npm i dotenv

then create a .env file in the backend folder with the following code

PORT ="<the port number that you will run the backend on>"
DATABASE ="<Your Mongo Connection String>"
JWT_SECRET ="<Your Mongo Connection String>"
JWT_EXPIRES_IN="<the time token will expire after. meaning that the user will auto signout after that time>"
JWT_COOKIE_EXPIRES_IN="<the time the stored cookies will expire after. should be the same as "JWT_EXPIRES_IN">"
EMAIL_USERNAME="<the email address you will use in sending notifications and promocodes via mail>"
EMAIL_PASSWORD="<the app password that you will use to uthinticate your email address refer to google security to know how to create app password>"
clientSecret = "<amadus key used for hotel and flight bookings >"
clientId = "<amadus key used for hotel and flight bookings >"
currencyConversionKey = "<currency conversion key used getting the conversion rate between currencies >"
STRIPE_SECRET_KEY="<stripe key used for payments >"

on the first terminal run the server using the commands

cd backend
nodemon server

on the second terminal run the clinet side using the commands

cd frontend
npm run start

API References

Activities

handles all operations related to activities on the system ans is used by /activities followed by the following :

POST /BookActivity/:ActivityId - book an activity

POST /BookActivity/:ActivityId - Book activity

Request

• Endpoint: /BookActivity/:ActivityId

• Method: POST

• Description: books the activity specified in the id for the signed in user. note this end point needs a JWT token.

• Request Body:

  {
    "PaymentMethod": "Wallet",
    "TotalPrice": 300,
    "NumberOfTickets": 3
  }

Response

{
  "message": "Booked successfully",
  "booking": {
    "UserId": "676451bfcc3eb0c6bdfb3f8a",
    "ActivityId": "672cbcce6227e653db4c7f9b",
    "Status": true,
    "PaymentMethod": "Wallet",
    "CardNumber": "",
    "NumberOfTickets": 3,
    "TotalPrice": 300,
    "_id": "676458bfcc3eb0c6bdfb3f97",
    "createdAt": "2024-12-19T17:32:47.059Z",
    "updatedAt": "2024-12-19T17:32:47.059Z",
    "__v": 0
  },
  "loyaltyPointsEarned": 750,
  "newTotalPoints": 150,
  "newLevel": 1,
  "newBadge": "Bronze",
  "newPoints": 150,
  "newWallet": 300
}

GET /MyActivityBookings - Create a new itinerary

GET /MyActivityBookings - My Activity Bookings

Request

• Endpoint: /MyActivityBookings
• Method: GET
• Description: show the logged in tourist all their booked activities. needs a JWT token.

Response

[
  {
    "_id": "676458bfcc3eb0c6bdfb3f97",
    "UserId": "676451bfcc3eb0c6bdfb3f8a",
    "ActivityId": {
      "locations": {
        "lon": "1234",
        "lan": "54321"
      },
      "isOpened": false,
      "_id": "672cbcce6227e653db4c7f9b",
      "author": "66fe6614193a10b4e3523979",
      "title": "Abdelhalim Hafez Concert",
      "description": "سهرة غنائية مع الفنان عبدالحليم حافظ بدار الأوبرا المصرية ",
      "start_date": "2024-11-11T00:00:00.000Z",
      "end_date": "2024-11-12T00:00:00.000Z",
      "price": 1500,
      "Category": "6701a3211120edeecf46a094",
      "discount": 5,
      "tag": "6724faaa6d94a24e93137efa",
      "bookingOpened": true,
      "ratingsAverage": 4.5,
      "ratingsQuantity": 0,
      "isFlagged": false,
      "createdAt": "2024-11-07T13:12:46.072Z",
      "updatedAt": "2024-12-19T17:32:47.542Z",
      "__v": 0,
      "isActive": true,
      "isBooked": true,
      "interestedUsers": ["674d976b0d385a0b92c2d5dc"]
    },
    "Status": true,
    "PaymentMethod": "Wallet",
    "CardNumber": "",
    "NumberOfTickets": 3,
    "TotalPrice": 300,
    "createdAt": "2024-12-19T17:32:47.059Z",
    "updatedAt": "2024-12-19T17:32:47.059Z",
    "__v": 0
  }
]

• / : a GET function that read all activities to be viewed by a tourist/guest and internally handles any filtering
• /getadvact : a GET function that reads all activites created by the logged in advertiser
• /createActivity : a POST function that allows advertisers to create a new activity
• /updateActivity/:id : a PATCH function to update an activity by id
• /deleteActivity/:id : a DELETE function to delete an activity by id
• /getOne/:id : a GET function to get a single activity by id
• /sortActivityByPrice : a GET function used to sort activites by price
• /getTitles :
• /openActivity/:id : a PATCH function used to set an activity's status to open by its id
• /shareActivity/:id : a GET function used to share an activity by its id
• /CancelActivityBooking : a PATCH function used to cancel a booked activity as long as it has not started
• /readActivitiesByIds : a GET function used to read multiple itineraries by the string of ids provided in the query

Itineraries

handles all operations related to itineraries on the system ans is used by /Event followed by the following :

POST /createItinerary - Create a new itinerary

POST /createItinerary - Create a new itinerary

Request

• Endpoint: /createItinerary

• Method: POST

• Description: Creates a new itinerary with activities, availability, and other details.

• Request Body:

  {
    "author": "66ff16b8be4fe3e1ff765d90",
    "activities": [
      {
        "name": "Hiking",
        "start_date": "2024-10-10",
        "end_date": "2024-10-11",
        "description": "A scenic mountain hiking tour."
      },
      {
        "name": "Boat Ride",
        "start_date": "2024-10-12",
        "end_date": "2024-10-12",
        "description": "A relaxing boat ride along the river."
      }
    ],
    "language": "English",
    "price": 150,
    "locations": ["Mountain Trail", "River Valley"],
    "pick_up": "City Center, Main Square",
    "drop_off": "City Center, Main Square",
    "availability": {
      "dates": ["2024-10-10", "2024-10-12"]
    },
    "isBooked": false,
    "booked_users": []
  }

Response

{
  "author": "66ff16b8be4fe3e1ff765d90",
  "activities": [
    {
      "name": "Hiking",
      "end_date": "2024-10-11T00:00:00.000Z",
      "description": "A scenic mountain hiking tour.",
      "_id": "676433af43a3234b9bb9469f"
    },
    {
      "name": "Boat Ride",
      "end_date": "2024-10-12T00:00:00.000Z",
      "description": "A relaxing boat ride along the river.",
      "_id": "676433af43a3234b9bb946a0"
    }
  ],
  "language": "English",
  "price": 150,
  "locations": ["Mountain Trail", "River Valley"],
  "pick_up": "City Center, Main Square",
  "drop_off": "City Center, Main Square",
  "availability": {
    "dates": ["2024-10-10T00:00:00.000Z", "2024-10-12T00:00:00.000Z"]
  },
  "isBooked": false,
  "booked_users": [],
  "ratingsAverage": 4.5,
  "ratingsQuantity": 0,
  "tags": [],
  "isActive": true,
  "isFlagged": false,
  "isOpened": false,
  "interestedUsers": [],
  "_id": "676433af43a3234b9bb9469e",
  "createdAt": "2024-12-19T14:54:39.938Z",
  "updatedAt": "2024-12-19T14:54:39.938Z",
  "__v": 0
}

PATCH /updateItinerary/:itineraryId - Update an itinerary by id

PATCH /updateItinerary/:itineraryId - Update an itinerary by id

Request

• Endpoint: /updateItinerary/:itineraryId

• Method: PATCH

• Description: Updates an existing itinerary with new activities, tags, and other details.

• Request Body:

  {
    "activities": [
      {
        "name": "Mountain test ys 3baqi",
        "end_date": "2024-12-01T11:00:00.000Z",
        "description": "A scenic hike through the mountain trails with a professional guide.",
        "_id": "67024111056c479208da9935"
      },
      {
        "name": "Lakeside Picnic",
        "end_date": "2024-12-01T14:00:00.000Z",
        "description": "A relaxing picnic by the lake with local delicacies and stunning views.",
        "_id": "67024111056c479208da9936"
      },
      {
        "name": "Volley Ball",
        "end_date": "2024-12-01T14:00:00.000Z",
        "description": "A relaxing picnic by the lake with local delicacies and stunning views."
      }
    ],
    "tags": ["67029818e93b4336b41ee134", "670189d71120edeecf46a036"]
  }

Response

{
  "availability": {
    "dates": []
  },
  "_id": "6703bfa0a040b8a99567f43a",
  "author": "66fffbc17931c2669f7d034c",
  "activities": [
    {
      "name": "Mountain test ys 3baqi",
      "end_date": "2024-12-01T11:00:00.000Z",
      "description": "A scenic hike through the mountain trails with a professional guide.",
      "_id": "67024111056c479208da9935"
    },
    {
      "name": "Lakeside Picnic",
      "end_date": "2024-12-01T14:00:00.000Z",
      "description": "A relaxing picnic by the lake with local delicacies and stunning views.",
      "_id": "67024111056c479208da9936"
    },
    {
      "name": "Volley Ball",
      "end_date": "2024-12-01T14:00:00.000Z",
      "description": "A relaxing picnic by the lake with local delicacies and stunning views.",
      "_id": "67643b1043a3234b9bb947b2"
    }
  ],
  "start_date": "2025-10-07T11:01:00.000Z",
  "end_date": "2025-10-24T11:01:00.000Z",
  "transportation": "Bus",
  "accommodation": "Milano Hotel",
  "language": "",
  "price": 103,
  "locations": ["Castle", "Museum", "kda y3ny"],
  "pick_up": "",
  "drop_off": "",
  "accessibility": "",
  "isBooked": true,
  "booked_users": [],
  "ratingsAverage": 4.5,
  "tags": ["67029818e93b4336b41ee134", "670189d71120edeecf46a036"],
  "createdAt": "2024-10-07T11:01:52.979Z",
  "updatedAt": "2024-12-19T15:26:08.665Z",
  "__v": 0,
  "isActive": true,
  "isFlagged": false,
  "title": "mashi",
  "category": null,
  "interestedUsers": ["67306b51011b72d218a47293"],
  "isOpened": true,
  "ratingsQuantity": 0
}

DELETE /itineraries/:id - Delete an itinerary by id

DELETE /itineraries/:id - Delete an itinerary by id

Request

• Endpoint: /itineraries/:id
• Method: DELETE
• Description: Deletes an existing itinerary by its id.

Response

{
  "status": "success",
  "message": "Itinerary deleted successfully."
}

GET /readAllItineraries - Read All Itineraries

GET /readAllItineraries - Read All Itineraries

Request

• Endpoint: /readAllItineraries
• Method: GET
• Description: Retrieves all itineraries and handles any internal filtering based on query parameters.

Response

[
  {
    "_id": "676433af43a3234b9bb9469e",
    "author": "66ff16b8be4fe3e1ff765d90",
    "title": "Mountain Adventure",
    "category": "Adventure",
    "activities": [
      {
        "name": "Hiking",
        "start_date": "2024-10-10T00:00:00.000Z",
        "end_date": "2024-10-11T00:00:00.000Z",
        "description": "A scenic mountain hiking tour."
      },
      {
        "name": "Boat Ride",
        "start_date": "2024-10-12T00:00:00.000Z",
        "end_date": "2024-10-12T00:00:00.000Z",
        "description": "A relaxing boat ride along the river."
      }
    ],
    "start_date": "2024-10-10T00:00:00.000Z",
    "end_date": "2024-10-12T00:00:00.000Z",
    "transportation": "Bus",
    "accommodation": "Mountain Lodge",
    "language": "English",
    "price": 150,
    "locations": ["Mountain Trail", "River Valley"],
    "pick_up": "City Center, Main Square",
    "drop_off": "City Center, Main Square",
    "availability": {
      "dates": ["2024-10-10T00:00:00.000Z", "2024-10-12T00:00:00.000Z"]
    },
    "isBooked": false,
    "booked_users": [],
    "ratingsAverage": 4.5,
    "ratingsQuantity": 0,
    "tags": ["Adventure", "Nature"],
    "isActive": true,
    "isFlagged": false,
    "isOpened": false,
    "interestedUsers": [],
    "createdAt": "2024-12-19T14:54:39.938Z",
    "updatedAt": "2024-12-19T14:54:39.938Z"
  }
]

• /readSingleItinerary/:itineraryId : a GET function to get a single itinerary by id
• shareItinerary/:id : a GET function to share an itinerary by its id
• /openBookings/:id : a PATCH function used to set an itinerary's status to open by its id
• /BookItinerary/:ItineraryId : a POST function used to book a certain itinerary by its id
• /MyItineraryBookings : a GET function used to show the logged in tourist all their booked itineraries
• /CancelItineraryBooking : a PATCH function used to cancel a booked itinerary as long as it has not started
• /readItinerariesByIds : a GET function used to read multiple itineraries by the string of ids provided in the query

Historical places

handles all operations related to historical places on the system ans is used by/Event followed by the following :

• /viewAllVintage : a GET function that read all historical places without applying any filters to them
• /readAllVintages : a GET function that read all historical places viewable to tourist/guest and internally handles any tag filtering
• /readSingleVintage/:vintageId : a GET function to get a single historical place by id
• /createvintage : a POST function to create a new historical place post
• /updateVintage/:vintageId : a PATCH function to update an historical place by id
• /deleteVintage/:id : a DELETE function to delete an historical place by id
• shareVintage/:id : a GET function to share an itinerary by its id

Products

handles all operations related to products on the system ans is used by /products followed by the following :

• / : a get function that returns all the products available in the market with all it info
• /:id : a get function that returns all the data for a single product which is specified by the id in the URL
• /getSellersProducts/:id : a get function that returns all the products for a specific seller using their id
• /getTitles/:id : a get function that returns all product titles taht belong to a user based on their id
• /createProduct : a post function that creates a new product by the seller that is currently logged in
• /deleteProduct/:id : a delet function that deletes a product from the system using the specified id
• /updateProduct/:id : a patch function that updates the info of the selected product using the id provided in the url
• /archiveProduct/:id : a patch function that updates the status of the selected product to be archived using the id provided in the url by seller or admin
• /unarchiveProduct/:id : a patch function that updates the status of the selected product to be unarchived using the id provided in the url by seller or admin
• /getTitles/:id : a get function that gets the titles of all the products available on the system for a selected seller or admin
• /tourist-products : a get function that gets the all products available on the system that matches a specified search or fillter

purchases

/purchaseRouter followed by the following :

• /productPurchases/:id : a get function that returns a specific product using id
• /purchases : a get function that returns all the data of all product on the system
• /userPurchases : a get function that returns all the purchases for the logged in user
• /makePurchase : a post function that handle the logic of purchasing in the data base
• /deleteProduct/:id : a delet function that deletes a product from the system using the specified id
• /updateProduct/:id : a patch function that updates the info of the selected product using the id provided in the url

Transportations

handles all operations related to transportations on the system ans is used by /transportation followed by the following:

• / : a get function that reads all transportations
• /getadvTrans : a get function that reads all transportations created by the logged in advertiser
• /getOne/:id : a GET function to get a single transportation by id
• /createTransportation : a POST function that allows advertisers to create a new transportation
• /updateTransportation/:id : a PATCH function to update a transportation by id
• /deleteTransportation/:id : a DELETE function to delete a transportaion by id
• /BookTransportation/:TransportationId : a post function to book a transportation using its id
• /MyBookings : a get request used to read a tourist's booked transportations
• /CancelBooking/:bookId : a patch request used to cancel a transportation booking using its id

flights and hotels

both flight and hotels are done using amadeus api and use /flights followed by the following:

• /cities : a get request that reads available cities and filters them based don user typing
• /getFlights : a get method that reads all available flights based on inputed fields
• /seatMap : a get method that reads the seatmap of a specific flight to get extra info about that flight
• /hotels : a get method that reads all available hotels based on inputed fields values
• /hotelDetails : a get method that reads all of a single hotel's booking details
• /BookFlight : a post method used to book an flight
• /BookHotel : a post method used to book an hotel
• /MyfBookings : a get request that reads all of a tourist's booked flights
• /MyhBookings : a get request that reads all of a tourist's booked hotels
• /CancelfBooking : a patch request that cancels a flight booking as long as its date hasnt come yet
• /CancelhBooking : a patch request that cancels a hotel booking as long as its start date hasnt come yet

tourist

handles all operations specific to tourist :

Post /fileComplaint - Sends a complaint

Post /fileComplaint - User Login

Request

• Endpoint: /fileComplaint

• Method: Post

• Description: allow a tourist to file a complaint. needs a JWT token.

• Request Body:

  {
    "title": "test",
    "body": "testing the complain end point"
  }

Response

{
  "status": "success",
  "data": {
    "complaint": {
      "title": "test",
      "body": "testing the complain end point",
      "status": "Pending",
      "user": "676451bfcc3eb0c6bdfb3f8a",
      "_id": "676475a7cc3eb0c6bdfb3fa4",
      "date": "2024-12-19T19:36:07.389Z",
      "__v": 0
    }
  }
}

GET /myComplaints - Sends a complaint

GET /myComplaints - User Login

Request

• Endpoint: /myComplaints
• Method: GET
• Description: retrives all of a tourist's filled complaints. needs a JWT token.

Response

{
  "status": "success",
  "results": 1,
  "data": {
    "complaints": [
      {
        "_id": "676475a7cc3eb0c6bdfb3fa4",
        "title": "test",
        "body": "testing the complain end point",
        "status": "Pending",
        "user": "676451bfcc3eb0c6bdfb3f8a",
        "date": "2024-12-19T19:36:07.389Z",
        "__v": 0
      }
    ]
  }
}

• /MyAccount : a get request to get a logged in tourist's account
• /updateMe : a patch request to update a logged in tourist's account
• /deleteMe : a delete request to delete a logged in tourist's account

advertiser

handles all operations specific to advertiser :

• /MyAccount : a get request to get a logged in advertiser's account
• /updateMe : a patch request to update a logged in advertiser's account
• /deleteMe : a delete request to delete a logged in advertiser's account

user

GET / - Read All Users

GET / - Read All Users

Response

[
  {
    "_id": "67580a1a6ba6acf0268b4241",
    "username": "hadwa_admin",
    "email": "[email protected]",
    "role": "Admin",
    "wallet": 0,
    "experience": [],
    "ratingsAverage": 4.5,
    "ratingsQuantity": 0,
    "previous_work": [],
    "years_of_experience": 0,
    "activities": [],
    "about": "test",
    "isActive": true,
    "verified": false,
    "activityGuests": 0,
    "documentApprovalStatus": "Pending",
    "certificates": [],
    "loyaltyPoints": 0,
    "level": 1,
    "badge": "Bronze",
    "pointsAvailable": 0,
    "selectedTags": [],
    "wishList": [],
    "savedEvents": [],
    "savedItineraries": [],
    "addresses": [],
    "createdAt": "2024-12-10T09:30:02.174Z",
    "updatedAt": "2024-12-10T09:30:02.174Z",
    "__v": 0
  },
  {
    "_id": "675763296ea83a5c273df4dc",
    "username": "tourtour",
    "email": "[email protected]",
    "role": "Tour_Guide",
    "mobile_number": "01067744295",
    "nationality": "",
    "DOB": null,
    "job": "",
    "wallet": 0,
    "experience": [],
    "ratingsAverage": 4.5,
    "ratingsQuantity": 0,
    "previous_work": [],
    "years_of_experience": 0,
    "sellerName": "",
    "description": "",
    "website_link": "http://guc.edu.eg",
    "hotline": null,
    "activities": [],
    "about": "",
    "isActive": true,
    "verified": false,
    "activityGuests": 0,
    "passwordChangedAt": "2024-12-09T21:37:45.126Z",
    "documentApprovalStatus": "Pending",
    "certificates": [
      "certificate-1733780265971-609784362.pdf",
      "certificate-1733780265971-854811437.pdf"
    ],
    "loyaltyPoints": 0,
    "level": 1,
    "badge": "Bronze",
    "pointsAvailable": 0,
    "selectedTags": [],
    "wishList": [],
    "savedEvents": [],
    "savedItineraries": [],
    "addresses": [],
    "createdAt": "2024-12-09T21:37:45.131Z",
    "updatedAt": "2024-12-09T21:37:46.236Z",
    "__v": 0,
    "idDocument": "id-1733780265970-288420360.png",
    "photo": "tour-guide-675763296ea83a5c273df4dc-69790ec4-9983-459f-8a09-11f96772be28.jpeg"
  }
]

POST /login - User Login

POST /login - User Login

Request

• Endpoint: /login

• Method: POST

• Description: Authenticates a user and returns a JWT token.

• Request Body:

  {
    "username": "adel",
    "password": "123456"
  }

Response

{
  "status": "success",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NjQzODNjNDNhMzIzNGI5YmI5NDZiYyIsImlhdCI6MTczNDYyMTI4NiwiZXhwIjoxNzQyMzk3Mjg2fQ.iKOso-u-7PmXDaywwpiKPlSDVVRSdOQLDureM9j-KeQ",
  "data": {
    "user": {
      "_id": "6764383c43a3234b9bb946bc",
      "username": "adel",
      "email": "[email protected]",
      "role": "Tourist",
      "mobile_number": "01555229073",
      "nationality": "Egypt",
      "DOB": "2005-02-16T00:00:00.000Z",
      "job": "meow",
      "wallet": 0,
      "experience": [],
      "ratingsAverage": 4.5,
      "ratingsQuantity": 0,
      "previous_work": [],
      "years_of_experience": 0,
      "sellerName": "",
      "description": "",
      "website_link": "http://guc.edu.eg",
      "hotline": null,
      "activities": [],
      "about": "",
      "isActive": true,
      "verified": false,
      "activityGuests": 0,
      "passwordChangedAt": "2024-12-19T15:14:04.507Z",
      "documentApprovalStatus": "Pending",
      "certificates": [],
      "loyaltyPoints": 0,
      "level": 1,
      "badge": "Bronze",
      "pointsAvailable": 0,
      "selectedTags": ["67029818e93b4336b41ee134", "6724fab76d94a24e93137efe"],
      "wishList": [],
      "savedEvents": [],
      "savedItineraries": ["6703bfa0a040b8a99567f43a"],
      "addresses": [],
      "createdAt": "2024-12-19T15:14:04.513Z",
      "updatedAt": "2024-12-19T15:14:40.365Z",
      "__v": 0
    }
  }
}

PATCH /update/:userId - Update User Data

PATCH /update/:userId - Update User Data

Request

• Endpoint: /update/:userId

• Method: PATCH

• Description: Updates user data for the specified user ID.

• Request Body:

  {
    "wishList": ["6727e1641335caa450eb86e0", "6727e317e14a2315d5dd6210"],
    "savedEvents": ["67016df580e6bc147dba786c", "67024b0e39b34c97c0efd15b"],
    "savedItineraries": [
      "66ff1f804abdd1e973ecc18e",
      "66fffe6bbd9ea1d61472dfab"
    ],
    "addresses": [
      {
        "street": "123 Main St",
        "city": "Springfield",
        "state": "IL",
        "postalCode": "62701",
        "country": "USA"
      }
    ]
  }

Response

{
  "acknowledged": true,
  "modifiedCount": 1,
  "upsertedId": null,
  "upsertedCount": 0,
  "matchedCount": 1
}

POST /signup - User signup

POST signup - User Login

Request

• Endpoint: /signup

• Method: POST

• Description: creates a new user in the system.

• Request Body:

  {
    "username": "TestUser",
    "email": "[email protected]",
    "password": "123456",
    "passwordConfirm": "123456",
    "role": "Tourist",
    "mobile_number": "12345678910",
    "nationality": "Egyptien",
    "job": "student",
    "DOB": "11-01-2024",
    "selectedTags": "67029818e93b4336b41ee134" //preference tags for user interests
  }

Response

{
  "status": "success",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NjQ1MWJmY2MzZWIwYzZiZGZiM2Y4YSIsImlhdCI6MTczNDYyNzc3NywiZXhwIjoxNzQyNDAzNzc3fQ.yf_rsQHPVS4i-J-xjnNbhMIbj5eHqYvOTHGFIyMqUYY",
  "data": {
    "user": {
      "username": "TestUser",
      "email": "[email protected]",
      "role": "Tourist",
      "mobile_number": "12345678910",
      "nationality": "Egyptien",
      "DOB": "2024-10-31T22:00:00.000Z",
      "job": "student",
      "wallet": 0,
      "experience": [],
      "ratingsAverage": 4.5,
      "ratingsQuantity": 0,
      "previous_work": [],
      "years_of_experience": 0,
      "activities": [],
      "isActive": true,
      "verified": false,
      "activityGuests": 0,
      "passwordChangedAt": "2024-12-19T17:02:55.653Z",
      "documentApprovalStatus": "Pending",
      "certificates": [],
      "loyaltyPoints": 0,
      "level": 1,
      "badge": "Bronze",
      "pointsAvailable": 0,
      "selectedTags": ["67029818e93b4336b41ee134"],
      "wishList": [],
      "savedEvents": [],
      "savedItineraries": [],
      "_id": "676451bfcc3eb0c6bdfb3f8a",
      "addresses": [],
      "createdAt": "2024-12-19T17:02:55.707Z",
      "updatedAt": "2024-12-19T17:02:55.707Z",
      "__v": 0
    }
  }
}

PATCH /UpdateWallet - updates user wallet

PATCH /UpdateWallet - User Login

Request

• Endpoint: /UpdateWallet

• Method: PATCH

• Description: updates the user wallet to handle refunds. JWT is needed for this end point to work.

• Request Body:

  {
    "numOfTickets": 3,
    "price": 200,
    "conversionRate": 1
  }

Response

{
  "message": "refund done successfully",
  "updatedWallet": 1
}

• /forgotPassword : a post request to ask the user if they forgot their password in case of wrong credentials
• /resetPassword/:token : a patch request used to reset a users password given their token
• /update/:userId : a patch request that updates user data given their id
• /pending-documents : a get request that allows an admin to view all pending requests
• /approve-document/:userId : a patch request that allows an admin to approve documents uploaded by a certain user identified by their id
• /reject-document : a patch request that allows an admin to reject documents uploaded by a certain user identified by their id
• /:id : a get request that returns all the info of a single user identified bu their id
• /upload-documents : a post request for users who are not tourist to upload documents to be reviewed by an admin
• /changePassword : a patch request to change a logged in user's password
• /RedeemPoints : a patch request to handle user reedeming points

admin

to handle admin specific operations using the url /admin followed by:

• /getTags : a get request to read all the tags on the system
• /createTag : a post request to create a new tag
• /updateTag/:id : a put request to pdate a tag using its id
• /deleteTag/:id : a delete request to delete a tag
• /getCategories : a get request to read all the categories on the system
• /createCategory : a post request to create a new category
• /updateCategory/:id : a put request to pdate a category using its id
• /deleteCategory/:id : a delete request to delete a category
• /addAdmin : a post request to add a new admin
• /deleteUser : a post request to delete a user
• /addTourismGovernor : a post request to adda tourism governer
• /viewAllComplaints : a get request to view all complaints on the system.
• /viewComplaint/:id : a get request to view a complaints based on its id
• /updateComplaintStatus/:id : a patch request to update a complaint's status by its id
• /replyToComplaint/:id : a post request to reply to a complaintusing its id
• /filterComplaintsByStatus/:status : get tequest to filter complaints by status
• /promo-code : post request to create a promo code
• /report : get request to generate a revenue report based on inputed fields
• /user_report : a get request that generates a report about users

experience

/experience followed by the following :

• /createExperience : a post function to create experience for the tour guide

notification

/notifications followed by the following :

• /unreade : a get function that returns the unread message of the current loggen in use
• / : a get function that returns all the notification messages of the current loggen in use
• /:id : a get function that returns the data of single notification using the id provided
• /:id : a delete function that delets the notification with the id provided
• /mark-all-read : a patch function that updates the read attribute of a the logged in user to true meaning that they are read.
• /:id/mark-read : a patch function that updates the read attribute of single notification to ture meaning that this notification is read by user this attribute is selected using the id provided in the url

review

this route is used to review activities,itineraries,tour guides and products using the url /review followed by the following :

• /activity : a post request to review a activity
• /itinerary : a post request to review a itinerary
• /tourGuide : a post request to review a tourGuide
• /product : a post request to review a product
• /:id : a get/delete/patch request that read/deletes/updates a review by its id

sales report

this route is used to generate sales reports :

• /activity : a post request to review a activity
• /itinerary : a post request to review a itinerary
• /tourGuide : a post request to review a tourGuide
• /product : a post request to review a product
• /:id : a get/delete/patch request that read/deletes/updates a review by its id

delete account request

handles all operations related to requests used by the url /delReq followed by the following:

-/createReq : a post method to create a delete request -/getReq : a get method to read a delete request -delReq : a delete method to delete a user's account

cart

used to handle all operations related to the cart as follows:

GET / - Get User's Cart

GET / - Get User's Cart

Request

• Endpoint: /
• Method: GET
• Description: Retrieves the cart of the logged-in user. Requires a JWT token.

Response

{
  "_id": "676483d8edef3d04b084735b",
  "userId": "66fffbc17931c2669f7d034c",
  "products": [
    {
      "productId": {
        "_id": "6727e1641335caa450eb86e0",
        "name": "ZNT11",
        "price": 122,
        "ratingsAverage": 1,
        "mainImage": "product-672f9cf2b93779a66f559132-main-87e12241-9e86-4308-8bd1-fd5bad91cd7f.jpeg"
      },
      "quantity": 3,
      "_id": "676483d8edef3d04b084735d"
    }
  ],
  "__v": 0
}

PATCH /edit - Edit User's Cart

PATCH /edit - Edit User's Cart

Request

• Endpoint: /edit

• Method: PATCH

• Description: Edits the user's cart by updating the quantity of a specified product. Requires a JWT token.

• Request Body:

  {
    "productId": "6727e1641335caa450eb86e0",
    "quantity": 1
  }

Response

{
  "_id": "676483d8edef3d04b084735b",
  "userId": "66fffbc17931c2669f7d034c",
  "products": [
    {
      "productId": "6727e1641335caa450eb86e0",
      "quantity": 3,
      "_id": "676483d8edef3d04b084735d"
    }
  ],
  "__v": 0
}

POST /checkout - Checkout User's Order

POST /checkout - Checkout User's Order

Request

• Endpoint: /checkout

• Method: POST

• Description: Processes the checkout for the user's cart. Requires a JWT token.

• Request Body:

  {
    "shippingAddress" : {
        "street": "123 Main St",
        "city": "Springfield",
        "state": "IL",
        "postalCode": "62701",
        "country": "USA"
    },
    "PaymentMethod": "wallet",
    "paymentAmount": 150
  }

Response

{
    "message": "Order placed successfully",
    "order": {
        "userId": "66fffbc17931c2669f7d034c",
        "products": [
            {
                "productId": "6727e1641335caa450eb86e0",
                "quantity": 3,
                "totalPrice": 366,
                "_id": "676486d8edef3d04b084738b"
            }
        ],
        "shippingAddress": {
            "street": "123 Main St",
            "city": "Springfield",
            "state": "IL",
            "postalCode": "62701",
            "country": "USA"
        },
        "totalPrice": 150,
        "state": "processing",
        "PaymentMethod": "wallet",
        "deliveryDate": "2024-12-26T20:49:28.676Z",
        "isCancelled": false,
        "purchaseIds": [
            "676486d8edef3d04b0847388"
        ],
        "_id": "676486d8edef3d04b084738a",
        "createdAt": "2024-12-19T20:49:28.678Z",
        "updatedAt": "2024-12-19T20:49:28.678Z",
        "__v": 0
    }
}

• /order/:id : a get method to read a simgle order by its id
• /remove/:id : a patch method to remove an item from a user's cart by its id -/clear : a patch method to clear a user's cart -MyOrders a get method to read all of a tourist's orders -/cancel : a patch method for a tourist to cancel an order -/checkout : a post method to checkout a cart

Tests

Tests were done primarily on Postman. To test an API endpoint using Postman, you can follow these general instructions:

1. Open Postman.
2. Select the HTTP method for the request: GET, POST, PUT, DELETE, etc.
3. Enter the endpoint URL in the address bar.
4. Optional: If the endpoint requires any query parameters or request body, add them in the corresponding sections.
5. Click the "Send" button to send the request.
6. Check the response status code and response body to ensure that the endpoint is functioning as expected.
7. Repeat the process for any additional endpoints you want to test.

Note: Some endpoints may require authentication or specific headers to be set in the request. Make sure to configure these accordingly in Postman before sending the request.

How to Use

Tourist

as a tourist you can sign up to create your won accountyou can then start brwosing throught all the activities/itineraries made by our advertisers and tour guides, look for gifts in our gift shop, or plan your transportation or acommodation through our various options
as a tourist you have a wallet in your profile that you can use for purchasses, you can also always change your prefrencesfor your suggessted feed

Advertiser

to sign up as an advertiser you simply follow the sign up page steps and wait for your uploaded documents to be approved by an admin.
after you have an account you can start creating either activities or transportations thta tourists can book with you.

Seller

to sign up as an advertiser you simply follow the sign up page steps and wait for your uploaded documents to be approved by an admin.
after you have an account you can start selling your products to tourists and can see reports of your sales.

Tour Guide

to sign up as an advertiser you simply follow the sign up page steps and wait for your uploaded documents to be approved by an admin.
after you have an account you can start creating detailed itinerares for tourists to book.
these itineraries include things like your language, any supported accomodation or transportation , and a list of activites that will be done during your itinerary.

Admin

you can only be added to the system by another admin.
once you are logged in,from your dashboard you can manage accounts, events, products, categories and preference tags.
you can manage accounts by adding other admins or tourism governors to the system and approving or rejecting non tourists signing up to the website.
you have full control over almost anything that the tourist is shown, from adding or editing products and such, to hiding or deleting them completely.
you can make promocodes and view and resolve complaints.
as an admin you can view reports of the types of users and the overall traffic on the website, and view sales report for everything being sold.

Contribute

For anyone who would like to contribute in the development of the project just clone the repository using following link:

git clone Advanced-computer-lab-2024/CariGo

Credits

• amadeus
• exchangerate-api.com
• netNinja mongoDb youtube
• netNinja mern stack youtube
• NetNinja node,express youtube
• Udemy the-complete-web-development-bootcamp
• Udemy nodejs-express-mongodb-bootcamp
• ChatGPT
• v0 by Vercel
• Material ui
• Mongoose docs
• Express docs
• ReactJs docs
• NodeJs docs
• Prettier docs
• MUI docs
• React Router docs
• React Hook Form docs

License

MIT License

Copyright (c) 2024 Rahma Ahmed, Yasmeen Mohamed Shaaban, Mohamed Hossameldin Abdulbaki , Menna Wahba

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.