** This Plugin is Still in Alpha release and is subject to breaking changes until V1 is offificially releases **

What does this plugin do?

This plugin queries Information from Holiday Extras Product Library. Details of the API can be found by visiting the Holiday Extras API Docs

Why should you use it?

This Service is great for generating information about products and services Holiday Extras provides. You can use this data to generate your own informational pages using Gatsby. We recommend using this service with your own content for SEO.

🚀 Quick start

npm install gatsby-source-holidayextras

Add environment variables

Environment variables allow you to safely store sensitive information about your projects, like your API Key or Access Tokem. At the root of your project, create two files:

.env.development .env.production

Then, add the variables on each file to match your Holiday Extras API information. HOLIDAY_EXTRAS_API_KEY HOLIDAY_EXTRAS_API_TOKEN

Configure the plugin

Define the plugin configuration in the gatsby-config.js file. The following gives a basic example of the plugin.

require('dotenv').config({
  path: `.env.${process.env.NODE_ENV}`,
})

module.exports = {
  plugins: [
    // ...
    {
      resolve: gatsby-source-holidayextras,
      options: {
        archived: false, // Default
        fasttrack: [array of Holiday Extras fasttrack codes],
        hotels: [array of Holiday Extras hotel codes],
        lounges: [array of Holiday Extras lounge codes],
        parking: [array of Holiday Extras car park codes],
        key: process.env.HOLIDAY_EXTRAS_API_KEY,
        token: process.env.HOLIDAY_EXTRAS_API_TOKEN
      }
    },
  ]
}

Running this in your project will return the recommended and optional keys listed on the Holiday Extras API Docs for Parking, Hotels and Lounges with a few exceptions.

Images are returned as an array of images Anything lists on the API docs as 'tripappXYZ' is now just XYZ for simplicity

Archived products can be included in your results by adding archived: true :warning: These products are no longer sold or updated by Holiday Extras

Extra fields include:

airport
productCode
productType

How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have your help.

Asking a question or reporting a bug: please feel free to open an issue.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more. Please also check our roadmap to see what ideas for improvements we already have

Submitting code changes: For small fixes, feel free to open a PR with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.