Gatsby Source Flotiq

Overview:

The gatsby-source-flotiq plugin is designed to pull data from Flotiq into Gatsby websites. With a simple installation process and configuration options, users can quickly integrate Flotiq data into their Gatsby projects. This plugin offers various features such as creating a blog, showcasing projects, events calendar, and products with categories. By including Flotiq’s Content Type Definitions, users can customize the data they wish to pull from Flotiq.

Features:

• Simple blog with Gatsby: Create a blog using Gatsby and easily pull data from Flotiq.
• Projects portfolio: Showcase projects on your Gatsby website by integrating Flotiq data.
• Events calendar: Build an events calendar by pulling data from Flotiq using this plugin.
• Products showcase: Showcase products on your Gatsby website by integrating Flotiq data.
• Products with categories showcase: Categorize and showcase products on your Gatsby website.
• Collaboration: Allow multiple users to collaborate on a Gatsby project by pulling data from Flotiq.
• Customizable: Configure the plugin by setting parameters such as the Flotiq API URL, authentication token, cache usage, object limits, download settings, and more.

Installation:

To install the gatsby-source-flotiq plugin, follow these steps:

1. Install the plugin using npm or yarn:

   npm install gatsby-source-flotiq
   

   or

   yarn add gatsby-source-flotiq
   

2. Add the plugin to your Gatsby config file:

   module.exports = {
       plugins: [
           {
               resolve: "gatsby-source-flotiq",
               options: {
                   baseUrl: "https://api.flotiq.com",
                   // Set other options as needed
               },
           },
       ],
   }
   

3. Configure the plugin options:

   • baseUrl: The URL to the Flotiq API. By default, it is set to “https://api.flotiq.com”.
   • authToken: Your Flotiq API token. Use a Read-only key if you only need to pull data, or a Read-write key if you also need to put data.
   • forceReload: Set to true if you want the plugin to pull data in full, or false to use cache. By default, it is set to false.
   • includeTypes: An array of Content Type Definitions used in the project. Include the “_media” CTD if you use images or files pulled from Flotiq.
   • objectsLimit: Limit the number of objects pulled from Flotiq. Useful for speeding up development reloads. In production, set it higher than the number of objects in any Content Type pulled to the project.
   • singleFetchLimit: Change the default number of objects downloaded in a single API call. Use an integer value from 1 to 5000. The default value is 1000.
   • maxConcurrentDataDownloads: Change the default number of concurrent connections. Use an integer value from 1 to 50. The default value is 10.
   • timeout: Set the time (in milliseconds) after which the connection to Flotiq should time out.
   • resolveMissingRelations: When the objectsLimit is smaller than the number of objects in CTDs, the plugin makes additional calls to pull missing data. Set this parameter to false to suppress this behavior.
   • downloadMediaFile: Set to true if you want media files to be downloaded and cached, making them fully available for use with gatsby-image and gatsby-image-sharp.

4. Add your API credentials to your .env file.

5. Add the required Content Type Definitions to your Flotiq instance.

Summary:

The gatsby-source-flotiq plugin enables Gatsby websites to easily integrate data from Flotiq. With its simple installation process, users can quickly set up the plugin and configure the options according to their project requirements. By providing features such as blog creation, project and product showcasing, events calendar, and collaboration capabilities, this plugin offers flexibility and customization for Gatsby developers. With the ability to customize data pulling parameters and media file download options, users can tailor the plugin to fit their specific needs.