FairFareFinder

README

FairFareFinder

Out of date

Updating readme (again)just to refresh the jobs FairFareFinder is a tool designed to help travelers find the best destinations for weekend getaways, prioritizing locations with ideal weather conditions and cost-effective travel options. It combines weather forecasts, event schedules, and price comparisons (including travel and accommodation costs) to suggest the most suitable locations for a short trip.

Design Documentation

Need to get an invitation to view the miro board

Features

• Weather Forecast Integration: Retrieves up-to-date weather information to suggest destinations with the best upcoming weather conditions.
• Cost Comparison: Compares travel and accommodation costs to find budget-friendly options.
• Event Scheduling: Identifies notable events happening at potential destinations.
• Customizable Search Parameters: Users can specify their preferences for travel time, budget, and type of activities.
• Automatic Updates: Regularly updates destination suggestions based on changing weather forecasts and prices.

Usage

Single Location

Checking Weather Pleasantness Index (WPI) for a Single Location To check the WPI for a single location, use the following command:

./exploding-wpi-and-adding-yaml-config [Location]

Replace [Location] with the name of the city or location you want to check.

Example:

./exploding-wpi-and-adding-yaml-config berlin

Multiple locations at once

Checking WPI for Multiple Locations (Favorites) You can define a list of favorite locations in a YAML file. To check the WPI for multiple favorite locations, edit the local or international YAML file retaining the following structure:

locations:
  - Location1
  - Location2
  - Location3
  # Add more locations as needed

Then, use the following command:

./exploding-wpi-and-adding-yaml-config favourites [YAMLFilename]

Replace [YAMLFilename] with either local_favourites or international_favourites

Example:

./exploding-wpi-and-adding-yaml-config international_favourites

Getting Started

Prerequisites

• Golang (version 1.x or later)
• Access to weather and accommodation APIs

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/FairFareFinder.git
   

2. Navigate to the project directory:

   cd FairFareFinder
   

3. Build the project (this will generate the FairFareFinder executable):

   go build
   

Usage

Run the FairFareFinder executable with the desired command-line arguments. For example:

./FairFareFinder Berlin

Replace Berlin with your preferred starting location for finding getaway destinations.

Configuration

• API Keys: Store your API keys in ignore/secrets.yaml. See ignore/secrets.example.yaml for the format.
• Custom Settings: Edit the configuration settings in config.yaml to adjust search parameters like maximum travel time and preferred weather conditions.

Contributing

Contributions to FairFareFinder are welcome! Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

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

Acknowledgments

• OpenWeatherMap API for weather data.
• Other API providers (if any).

---

Make sure to replace placeholder URLs and texts with actual information relevant to your project, and add or remove sections as necessary to match your project's features and setup.

install go

sudo apt install golang

go run main.go

installing go packges

go get gopkg.in/yaml.v2