Skip to content

Moriyan1307/Muzfir

Repository files navigation

Muzfir

A comprehensive travel planning application that uses AI to generate personalized itineraries, find flights, book hotels, and provide weather and security information for your destinations.

Features

  • AI-Powered Itinerary Generation: Create personalized day-by-day travel plans based on your preferences
  • Flight Search: Find and compare flights for your journey
  • Hotel Booking: Discover and book accommodations at your destination
  • Weather Information: Get weather forecasts and alerts for your travel dates
  • Travel Advisories: Access security alerts and travel advisories for your destinations
  • Itinerary Management: Save, load, and share your travel plans
  • User Authentication: Secure login with Google or phone number

Tech Stack

  • Frontend: Next.js, React, TypeScript, Tailwind CSS
  • Backend: Firebase (Authentication, Firestore)
  • APIs:
    • OpenAI API for itinerary generation
    • TripAdvisor API for hotel search
    • Amadeus API for flight search
    • OpenWeatherMap API for weather information
    • Travel Advisory APIs for security information

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • Firebase account
  • API keys for:
    • OpenAI
    • TripAdvisor
    • Amadeus
    • OpenWeatherMap

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/travel-ai-companion.git
    cd travel-ai-companion
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Create a .env.local file in the root directory with the following variables:

    NEXT_PUBLIC_FIREBASE_API_KEY=your_firebase_api_key
    NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
    NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_firebase_project_id
    NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
    NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
    NEXT_PUBLIC_FIREBASE_APP_ID=your_firebase_app_id
    NEXT_PUBLIC_OPENAI_API_KEY=your_openai_api_key
    NEXT_PUBLIC_TRIPADVISOR_API_KEY=your_tripadvisor_api_key
    NEXT_PUBLIC_AMADEUS_CLIENT_ID=your_amadeus_client_id
    NEXT_PUBLIC_AMADEUS_CLIENT_SECRET=your_amadeus_client_secret
    NEXT_PUBLIC_OPENWEATHER_API_KEY=your_openweather_api_key
    
  4. Start the development server:

    npm run dev
    # or
    yarn dev
  5. Open http://localhost:3000 in your browser to see the application.

Usage

Creating a New Itinerary

  1. Sign in to your account or create a new one
  2. Fill out the travel form with your:
    • Origin and destination
    • Travel dates
    • Budget
    • Number of travelers
    • Trip nature (leisure, business, family, etc.)
  3. Click "Generate Itinerary" to create a personalized travel plan
  4. View your generated itinerary with day-by-day activities

Finding Flights and Hotels

  1. After generating an itinerary, the app will automatically search for flights and hotels
  2. View available options in the "Flights" and "Hotels" tabs
  3. Compare prices, durations, and amenities
  4. Click on a booking link to complete your reservation on the provider's website

Weather and Security Information

  1. The app automatically fetches weather forecasts for each day of your trip
  2. View weather information in the itinerary tab
  3. Check for any weather alerts or security advisories for your destinations
  4. Plan accordingly based on the weather forecast

Saving and Loading Itineraries

  1. Click "Save Itinerary" to store your travel plan
  2. Access your saved itineraries from the dashboard
  3. Click on a saved itinerary to load it and view all details
  4. Share your itinerary with friends or family

Project Structure

travel-ai-companion/
├── app/                  # Next.js app directory
│   ├── api/              # API routes
│   ├── dashboard/        # Dashboard pages
│   ├── login/            # Authentication pages
│   └── ...
├── components/           # React components
├── lib/                  # Utility functions and API integrations
├── public/               # Static assets
├── styles/               # CSS styles
└── types/                # TypeScript type definitions

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • OpenAI for providing the AI capabilities
  • TripAdvisor, Amadeus, and OpenWeatherMap for their APIs
  • Firebase for authentication and database services
  • Next.js team for the amazing framework

About

A comprehensive travel planning application that uses AI to generate personalized itineraries, find flights, book hotels, and provide weather and security information for your destinations.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors