sandeepB3 / TripBuilderAI

TripBuilderAI - An Itinerary building web app based on user budget and preference using OpenAI API and prompt engineering

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TripBuilderAI

Looking for a hassle-free way to plan your next trips?
Look no further than TripBuilderAI, the travel itinerary generator that does the hard work for you. Create a customized itinerary that matches your preferences and budget, so you can focus on enjoying your journey.

Features

  • A full day by day itinerary based on your preferences
  • Refine your trip. We'll find the best routes and schedules
  • Easily make changes or add new activities to your itinerary
  • Access your itinerary on the go and get real-time updates

API Reference

Skyscanner API

For Required Header Parameters - Refer API Documentation

https://skyscanner50.p.rapidapi.com/api/v1/searchPlace
https://skyscanner50.p.rapidapi.com/api/v1/searchHotel
https://skyscanner50.p.rapidapi.com/api/v1/getThingsToDo
Parameter Type Description
X-RapidAPI-Key enum Your API key (Required)
X-RapidAPI-Host string RapidAPI Host (Required)

Refer the above documentation for code snippets and example response

OpenAI API

For Required Parameters - Refer API Documentation

Parameter Type Description
apiKey enum Your API key (Required)

Refer the above documentation for code snippets and example response

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

OPENAI_API_KEY

MONGO_URL

skyscanner_URL

You will need to make an account with RapidAPI and fill in some credit card details to obtain the API Key. (You will not be charged anything for the same).

You may also use any other API as per your convenience.

Run Locally

Clone the project

  git clone https://github.com/sandeepB3/TripBuilderAI.git

Go to the react-app and backend project directories, respectively

  cd react-App
  cd backend

Install dependencies

  npm install

Create .env file in backend folder & fill the env variables as shown above

  touch .env

Start both client and the server - Both run independently on different ports

  npm start - client
  nodemon index.js - server

Tech Stack

Client: React, MaterialUI, Context

Server: Node, Express, OpenAI, API's, MongoDB

Screenshots

Screenshot 2023-05-31 at 10 18 36 AM Screenshot 2023-05-31 at 10 18 49 AM Screenshot 2023-05-31 at 10 26 56 AM Screenshot 2023-05-31 at 2 33 09 PM

The Itinerary Page has not been styled yet - Contributions are welcomed

Future Scope

  • Support for accessibility feature - Map Box
  • Dark / Light mode - Toggle UI
  • Conversation Mode - Converse with AI to update the Itinerary

About

TripBuilderAI - An Itinerary building web app based on user budget and preference using OpenAI API and prompt engineering


Languages

Language:CSS 63.4%Language:JavaScript 33.5%Language:HTML 3.1%