travel-tales

Travel Tales travel planning platform designed to simplify your journey. Enter your destination, and let TripWise handle the logistics, from generating a customized itinerary to providing real-time weather updates and budget estimates.

Installation

Installation and running of this project to the local machine may vary the dependencies. You may follow the Installation process :

1. Copy the URL for the repository. To clone the repository using HTTPS, under "HTTPS", click. To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click SSH, then click.To clone a repository using GitHub CLI, click GitHub CLI, then click .

2. Open Git Bash.

3. Change the current working directory to the location where you want the cloned directory.

4. Clone the repository to your local machine using the following command:

  git clone https://github.com/your-username/your-project.git

5. Press Enter to create your local clone.

6. Go to the project directory

  cd project-Name

7. Install dependencies

  npm install

Run Locally

Start the Server

  npm run start:dev

This will start the development server and it will be accessible at http://localhost:port. Port may vary from machine to machine.

Environment Variables

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

PRIVATE_KEY

API Reference

Task 1

Create A New Trip

  POST /trip/

• Accepts a JSON object with trip details (place_name, location, budget, days, startDate, and endDate)

Generate Trip Plan

  POST /generate-plan/

• Accepts a JSON object (TravelRequest) with the following fields:
  • destination: String (e.g., "Saint Martin")
  • user_preferences: JSON object containing:
    • budget (e.g., "luxury")
    • transport_type (e.g., "train")
    • meal_preference (e.g., "vegetarian")
• The Google API key (GOOGLE_API_KEY) is fetched from environment variables to make external calls.
• The function checks if the destination exists in the predefined location_coordinates dictionary.
• The Google Places API is used to fetch nearby hotels based on destination coordinates.
• OpenAI's GPT-3.5-turbo model is called to generate a personalized travel itinerary based on user preferences and nearby hotel information.

Task 2

Integrating A Map

  GET /nominatim.openstreetmap.org/search/

• This API endpoint is used to search for locations based on user queries (e.g., city names, landmarks, addresses).
• The query is passed as part of the URL, and the result returns latitude and longitude coordinates for the location, which can then be plotted on a map.

Display Key Itinerary Information

  POST /nearby-hotels/

• The user provides the latitude, longitude, and type of places (e.g., hotel, restaurant) they are searching for.
• The Google Places API is used to fetch nearby hotels based on the provided coordinates and search type

Task 3

Integrating Weather Information

  GET /api.open-meteo.com/v1/forecast/

• The user provides latitude, longitude, start_date, and end_date as inputs to specify the location and time range for weather data collection.
• The function sets the url to the Open Meteo API endpoint (https://api.open-meteo.com/v1/forecast).

Task 4

Generate blog

  POST /generate-blog/

• This function generates a travel blog based on user input and weather data.
• The weather summary and user input are combined to form a prompt, which is sent to OpenAI's GPT model to generate a creative travel blog.

Task 5

Upload Images into Albums

  POST /{trip_id}/{album_id}/image/

• This handles image uploads into specific trip albums.

Analyze Image for Caption Generation

  POST /analyze-image/

• Uses OpenAI's API to analyze an image and return a description with relevant tags.

Search for Similar Images

  POST /search-similar-images/

• Search for images similar to the one provided in the search query.
• The function formats the results in a list of ImageResponse objects containing the image URL and the similarity score.