Holiday Tracker Plugin for Backstage

The Holiday Tracker Plugin for Backstage provides a convenient way to display and manage holiday information for any specified country or region using the Calendarific API. This plugin includes a secure backend proxy configuration to fetch holiday data without exposing your API key.

Installation

To install the plugin, run the following command:

yarn --cwd packages/app add @infosys_ltd/holiday-tracker-plugin

After installation, create an account on Calendarific and generate your API Access Key.

Configuration

Backend Proxy Configuration

Update your app-config.yaml file with the following proxy configuration:

proxy:
  endpoints:
    '/holidays':
      target: 'https://calendarific.com/api/v2/holidays?api_key=YOUR_API_KEY&country=YOUR_DEFAULT_LOCATION&year=YOUR_HOLIDAY_YEAR'
      changeOrigin: true

Important Notes:

• Replace YOUR_API_KEY with your Calendarific API key.
• Replace YOUR_DEFAULT_LOCATION with the desired default location (e.g., IN).
• Replace YOUR_HOLIDAY_YEAR with the desired year (e.g., 2025).

This configuration ensures:

• The api_key (API key) is securely embedded in the proxy target URL.
• The country parameter specifies the default location for calendar data.
• The year parameter specifies the year for calendar data.

Using Environment Variables (Optional)

Instead of hardcoding the api_key,country,year in the configuration file, you can dynamically set them via environment variables. This approach is more secure and flexible.

Set the following environment variables in your CLI:

export HOLIDAY_TRACKER_ACCESS_KEY=your_api_key_here
export HOLIDAY_TRACKER_LOCATION=your_default_location_here
export HOLIDAY_TRACKER_YEAR=your_default_year_here

Then update the app-config.yaml as follows:

proxy:
  endpoints:
    '/holidays':
      target: 'https://calendarific.com/api/v2/holidays?api_key=${HOLIDAY_TRACKER_ACCESS_KEY}&country=${HOLIDAY_TRACKER_LOCATION}&year=${HOLIDAY_TRACKER_YEAR}'
      changeOrigin: true

Example Screenshots

Holiday Tracker Plugin Configuration:

import { HolidayTrackerPage } from '@infosys_ltd/holiday-tracker-plugin';

[!NOTE] You have to import above HolidayTrackerPage and use it wherever its needed.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.