Safarny

Project Title

Safarny

Motivation

The Safarny project aims to revolutionize the travel planning experience by offering a comprehensive, user-friendly platform where users can seamlessly plan, book, and manage their travel itineraries. This project addresses the common challenges faced by travelers, such as finding reliable information, booking multiple services, and keeping track of travel plans, all within a single application. By integrating various services like accommodation, transportation, activities, and historical places, Safarny simplifies the travel planning process, making it accessible and efficient for users. The motivation behind this project is to enhance the travel experience, reduce planning stress, and provide a one-stop solution for all travel-related needs.

Build Status

Code Style

CommonJs

Screenshots

Tech/Framework Used

• JavaScript
• CSS
• React
• Express
• MongoDB
• Mongoose
• Bootstrap
• Ant Design
• Leaflet
• Stripe
• Firebase
• Axios
• Mailjet
• Vite

Features

• Seamless travel planning and management
• Integration of accommodation, transportation, activities, and historical places
• User-friendly interface for booking multiple services
• Efficient itinerary tracking and management
• Comprehensive user profiles for tourists, tour guides, sellers, and advertisers
• Admin and tourism governor functionalities for overseeing operations
• Advanced search and filter options for activities, itineraries, and historical places
• Notification and email services for updates and reminders
• Authentication and security features for user accounts
• Seamless Product Purchasing for convience
• Promo code management for discounts and offers

Code Examples

Here are some code examples that illustrate how to use the project:

Example 1: Promo Code Controller

This example demonstrates CRUD operations for promo codes in the server.

const PromoCode = require("../models/PromoCode.js");
const axios = require("axios");

const createPromoCode = async (req, res) => {
  try {
    const { discountPercentage, activated, createdBy, code, expiryDate } = req.body;
    const newPromoCode = new PromoCode({ discountPercentage, activated, createdBy, code, expiryDate });
    const savedPromoCode = await newPromoCode.save();
    res.status(201).json({ message: "Promo code created successfully", promoCode: savedPromoCode });
  } catch (err) {
    res.status(500).json({ error: err.message });
  }
};

const getPromoCodeById = async (req, res) => {
  try {
    const promoCodeId = req.params.id;
    const promoCode = await PromoCode.findById(promoCodeId);
    if (!promoCode) return res.status(404).json({ message: "Promo code not found" });
    res.status(200).json(promoCode);
  } catch (err) {
    res.status(500).json({ error: err.message });
  }
};

const updatePromoCode = async (req, res) => {
  try {
    const promoCodeId = req.params.id.trim();
    const { discountPercentage, activated, code, expiryDate } = req.body;
    const updatedPromoCode = await PromoCode.findByIdAndUpdate(
      promoCodeId, { discountPercentage, activated, code, expiryDate }, { new: true, runValidators: true });
    if (!updatedPromoCode) return res.status(404).json({ message: "Promo code not found" });
    res.status(200).json({ message: "Promo code updated successfully", promoCode: updatedPromoCode });
  } catch (err) {
    res.status(500).json({ error: err.message });
  }
};

const getAllPromoCodes = async (req, res) => {
  try {
    const promoCodes = await PromoCode.find();
    res.status(200).json(promoCodes);
  } catch (err) {
    res.status(500).json({ error: err.message });
  }
};

module.exports = { createPromoCode, getPromoCodeById, updatePromoCode, getAllPromoCodes };

Example 2: Profile Component

This example demonstrates how to fetch and display user profile information.

import React, { useEffect, useState } from 'react';
import axios from 'axios';
import { useParams, useNavigate } from 'react-router-dom';
import styles from './Profile.module.css';

const Profile = () => {
  const { userId } = useParams();
  const navigate = useNavigate();
  const [userInfo, setUserInfo] = useState({});
  const [message, setMessage] = useState('');
  const [audioRef, setAudioRef] = useState(null);

  useEffect(() => {
    const fetchUserData = async () => {
      try {
        const response = await axios.get(`/user/${userId}`);
        setUserInfo(response.data);

        // Fetch promo codes
        const promoResponse = await fetch('/promocodes/promocodes');
        if (!promoResponse.ok) throw new Error("Failed to fetch promo codes");
        const promoCodes = await promoResponse.json();
        const randomPromoCode = promoCodes[Math.floor(Math.random() * promoCodes.length)];

        // Send notification
        await axios.post('/notification/create', {
          title: 'Promo Code',
          userId,
          message: `You have received a promo code: ${randomPromoCode.code}`
        });

        // Send email
        await axios.post('/email/send-email', {
          to: response.data.email,
          subject: 'Your Promo Code',
          text: `Congratulations! You have received a promo code: ${randomPromoCode.code}`
        });
      } catch (error) {
        console.error("Error fetching user data:", error);
      }
    };

    fetchUserData();

    return () => {
      if (audioRef) {
        audioRef.pause();
        setAudioRef(null);
      }
    };
  }, [userId, audioRef]);

  const handleCashInPoints = async () => {
    try {
      if (userInfo.loyaltyPoints === 0) {
        setMessage("You do not have any loyalty points!");
        return;
      }

      const response = await fetch(import.meta.env.VITE_EXCHANGE_API_URL);
      if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
      const data = await response.json();
      const exchangeRate = data.conversion_rates[userInfo.walletcurrency];
      const pointsInWallet = userInfo.loyaltyPoints * 0.01 * exchangeRate;

      if (isNaN(pointsInWallet)) throw new Error("Invalid points calculation");

      await axios.put(`/tourist/${userId}`, {
        wallet: userInfo.wallet + pointsInWallet,
        loyaltyPoints: 0
      });

      setUserInfo((prevState) => ({
        ...prevState,
        wallet: prevState.wallet + pointsInWallet,
        loyaltyPoints: 0
      }));

      setMessage("Points redeemed!");
    } catch (error) {
      console.error("Error cashing in points:", error);
    }
  };

  return (
    <div className={styles.container}>
      <h1>Profile</h1>
      <p>{message}</p>
      <button onClick={handleCashInPoints}>Cash in Points</button>
    </div>
  );
};

export default Profile;

Installation

To install and set up the project, follow these steps:

1. Clone the repository:

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

2. Install dependencies and run the development server:

npm i
npm run dev

API Endpoints Documentation

Tags Related Operations

• POST /tags: Create a new tag
• GET /tags: Get all tags
• GET /tags/filter/:name: Get tags by filter
• GET /tags/:id: Get a tag by ID
• PUT /tags/:id: Update a tag by ID
• DELETE /tags/:id: Delete a tag by ID

---

Email Related Operations

• POST /email/send-activity-archived-email: Send activity archived email
• POST /email/send-itinerary-archived-email: Send itinerary archived email
• POST /email/send-tourist-reminder-email: Send tourist reminder email
• POST /email/send-email: Send general email

---

Admin Related Operations

• POST /admin/promocodes: Create a promo code
• GET /admin/promocodes: Get all promo codes
• GET /admin/promocodes/:id: Get promo code by ID
• PUT /admin/promocodes/:id: Update a promo code by ID
• GET /admin/getActivitiesRevenue: Get activities revenue
• GET /admin/getItinerarayRevenue: Get itinerary revenue
• GET /admin/getUsers: Get all users
• DELETE /admin/deleteUser/:id: Delete a user by ID
• PUT /admin/updateUser/:id: Update a user by ID
• PUT /admin/updateUserStatus/:id: Update user status by ID
• PUT /admin/UpdateProfileById: Update profile by ID
• POST /admin/addAdmin: Add a new admin
• POST /admin/createProduct: Create a new product
• GET /admin/products: Get all products
• GET /admin/products/:id: Get a product by ID
• PUT /admin/products/:id: Update a product by ID
• DELETE /admin/products/:id: Delete a product by ID
• POST /admin/tag: Create a tag
• GET /admin/tag: Get all tags
• GET /admin/tag/filter/:name: Get tags by filter
• GET /admin/tag/:id: Get a tag by ID
• PUT /admin/tag/:id: Update a tag by ID
• DELETE /admin/tag/:id: Delete a tag by ID
• POST /admin/add-governor: Add a new governor
• GET /admin/complaints: Get all complaints
• GET /admin/getAllRevenue: Get total revenue
• PUT /admin/complaints/:id: Update a complaint by ID
• DELETE /admin/deleteByCreator/:creatorId: Delete posts by creator ID
• DELETE /admin/deleteTourGuide/:id: Delete tour guide by ID
• DELETE /admin/deleteAdvertiser/:id: Delete advertiser by ID
• GET /admin/userCounts: Get user counts
• GET /admin/filteredrevenueadmin: Get filtered admin revenue

---

Guest Related Operations

• POST /guest/login: User login
• POST /guest/tourist-signup: Tourist signup
• POST /guest/others-signup: Signup for other roles (TourGuide, Advertiser, Seller)
• GET /guest/get-itineraries: Get all itineraries
• GET /guest/get-activities: Get all activities
• GET /guest/get-historicalPlaces: Get all historical places
• GET /guest/filter-activities: Filter activities
• GET /guest/get-activities-sorted: Get sorted activities
• GET /guest/get-itineraries-sorted: Get sorted itineraries
• GET /guest/filter-itineraries: Filter itineraries
• GET /guest/filter-historicalPlaces: Filter historical places
• GET /guest/get-historicalPlaces-sorted: Get sorted historical places

---

Login Related Operations

• POST /login/: User login

---

Post Related Operations

• POST /posts/posts: Create a post
• GET /posts/posts: Get all posts
• PUT /posts/posts/:id: Update a post by ID
• DELETE /posts/posts/:id: Delete a post by ID

---

User Related Operations

• GET /users/: Get users
• GET /users/all: Get all users
• DELETE /users/:id: Delete a user by ID
• GET /users/about: Get a single user
• PUT /users/update: Update a user
• POST /users/create: Create a new profile
• GET /users/:id: Get a profile by ID
• PUT /users/:id: Update a profile by ID
• PUT /users/Status/:id: Update user status by ID

Tests

Postman

http://localhost:3000/toursimgovernor/gettags:

http://localhost:3000/guest/get-activities

http://localhost:3000/admin/products

http://localhost:3000/guest/get-activities-sorted

http://localhost:3000/admin/tag

http://localhost:3000/admin/userCounts

http://localhost:3000/admin/complaints

http://localhost:3000/toursimgovernor/places

https://test.api.amadeus.com/v2/shopping/flight-offers?originLocationCode=NYC&destinationLocationCode=CAI&departureDate=2025-01-01&adults=1

https://test.api.amadeus.com/v1/reference-data/locations/hotels/by-city?cityCode=PAR&radius=5&radiusUnit=KM

https://test.api.amadeus.com/v1/reference-data/locations/hotels/by-hotels?hotelIds=YXPARRND

http://localhost:3000/tourguide/getItineraryRevenueByTourGuide/6706421efda16b0a35e52ed3

http://localhost:3000/promocodes/promocodes

http://localhost:3000/tourguide/get-itineraries

http://localhost:3000/admin/getUsers?role=Advertiser

How to Use

To use the Safarny project, follow these steps:

1. Run the Development Server

   • Make sure you have the necessary dependencies installed (see Installation section).
   • Start the development server using the following command:

     npm run dev
     

2. Access the Application

   • Open your browser and navigate to the local server URL, typically:

     http://localhost:3000
     

3. Explore the Features

   • Use the navigation menu to explore different features of the application.
   • For example, you can view activities, manage wishlists, and more.

4. API Endpoints

   • Utilize the API endpoints listed in the API References section to interact with the backend services.
   • Here is an example of how to fetch activities:

     fetch('/activities')
       .then(response => response.json())
       .then(data => console.log(data))
       .catch(error => console.error('Error:', error));

5. User Interactions

   • Different user roles (admin, advertiser, tourist, etc.) have unique functionalities.
   • Ensure you are logged in with the appropriate role to access specific features.

6. Modify and Extend

   • Feel free to modify the codebase to suit your needs.
   • Refer to the code examples provided in the README for guidance on how to extend functionalities.

Contribute

We welcome contributions to the Safarny project! Here's how you can help:

1. Fork the Repository

   • Click on the "Fork" button at the top right corner of this page to create a copy of this repository in your GitHub account.

2. Clone Your Fork

   • Clone your forked repository to your local machine:

     git clone https://github.com/YOUR_USERNAME/Safarny.git
     cd Safarny
     

3. Create a Branch

   • Create a new branch for your feature or bug fix:

     git checkout -b feature-or-bugfix-name
     

4. Make Changes

   • Make your changes in the codebase using your preferred code editor.

5. Commit Your Changes

   • Commit your changes with a descriptive commit message:

     git add .
     git commit -m "Description of changes"
     

6. Push to GitHub

   • Push your changes to your forked repository:

     git push origin feature-or-bugfix-name
     

7. Create a Pull Request

   • Go to the original repository and create a pull request from your forked repository.
   • Provide a clear description of what you have done and why your changes should be merged.

Credits

We would like to thank the following people and resources:

• Project Contributors

  • tareksherif64 - Tarek Sherif
  • seif495 - Seifeldin Moheb
  • youssef20031 - Youssef Maged
  • NirvanaKhaled - Nirvana Khaled
  • 1Oomar - Omar Elshazly
  • Odyjo - Ahmed Sameh
  • Elbasha3omarr - Omar Walid
  • AhmedV100 - Ahmed Mohamed
  • MrKaiba - Mohamed Youssef
  • MostafaVT - Mostafa Ahmed

• External Libraries and Frameworks

  • React
  • Express
  • MongoDB
  • Mongoose
  • Bootstrap
  • Ant Design
  • Leaflet
  • Stripe
  • Firebase
  • Axios
  • Mailjet
  • Vite
  • Mui

• Additional Acknowledgements

• Special thanks to all the online resources and tutorials that helped us build this project.

• (https://www.youtube.com/playlist?list=PLillGF-RfqbbQeVSccR9PGKHzPJSWqcsm)

• (https://youtu.be/ofme2o29ngU?si=wlr0ZA-he_k4z7iw)

• (https://youtu.be/CgkZ7MvWUAA?si=-eq0Cokfv_9FOeEa)

License

The project is licensed under the GNU General Public License v3.0.