{"id":18244428,"url":"https://github.com/flotiq/flotiq-ui-plugin-chatgpt-faq-generator","last_synced_at":"2025-04-08T18:45:21.814Z","repository":{"id":239589178,"uuid":"796611815","full_name":"flotiq/flotiq-ui-plugin-chatgpt-faq-generator","owner":"flotiq","description":"Create FAQ entry for blog post","archived":false,"fork":false,"pushed_at":"2024-08-12T08:07:17.000Z","size":686,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-14T14:51:48.591Z","etag":null,"topics":["flotiq","flotiq-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flotiq.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-06T09:37:38.000Z","updated_at":"2024-07-02T15:50:02.000Z","dependencies_parsed_at":"2024-05-13T14:02:23.769Z","dependency_job_id":"903fed42-e5f1-4f78-bd99-b872f445f574","html_url":"https://github.com/flotiq/flotiq-ui-plugin-chatgpt-faq-generator","commit_stats":null,"previous_names":["flotiq/flotiq-ui-plugin-chatgpt-faq-generator"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flotiq","download_url":"https://codeload.github.com/flotiq/flotiq-ui-plugin-chatgpt-faq-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247908958,"owners_count":21016474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flotiq","flotiq-plugin"],"created_at":"2024-11-05T09:16:38.446Z","updated_at":"2025-04-08T18:45:21.789Z","avatar_url":"https://github.com/flotiq.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[[_TOC_]]\n\n# ChatGTP FAQ Generator Plugin Documentation\n\n## Overview\nThe ChatGTP FAQ Generator plugin automates the creation of FAQs from your content, streamlining the process of generating and saving FAQs to your desired field.\n\n## Usage\n\n1. Open the FAQ Generator settings modal.\n2. Enter your OpenAI API key in the provided field.\n3. Configure the content types and source/target fields according to your content structure.\n4. Click 'Save changes' to apply the settings.\n5. Go to object in one of the selected content types.\n6. Locate the target field and click the FAQ icon on the left.\n    ![FAQ button](./.docs/empty-faq-field.png)\n\n7. Once new FAQ is generated, save the content object.\n    ![Generated FAQ](./.docs/generated-faq.png)\n\n## Configuration\n\n![FAQ plugin settings](./.docs/plugin-settings.png)\n\n### OpenAI API Key\nInsert your OpenAI API key here. It should begin with `sk-...`.\n\n### Content Types\nSelect the type of content you want to generate FAQs from.\n\n### FAQ Source Field\nChoose the field from which the FAQ will be generated. Supported types include:\n- Textarea\n- Richtext\n- Markdown\n- Block\n\n### FAQ Target Field\nSpecify the field where the FAQ will be saved. Supported types are:\n- Textarea\n- List - must contain two fields: \n   - question (text or textarea)\n   - answer (text or textarea)\n\n## Development\n\n### Quick start\n\n1. `yarn` - to install dependencies\n2. `yarn start` - to start development mode - rebuild on file modifications\n3. update your `plugin-manifest.json` file to contain the production URL and other plugin information\n4. `yarn build` - to build plugins\n\n### Dev environment\n\nDev environment is configured to use:\n\n* `prettier` - best used with automatic format on save in IDE\n* `eslint` - it is built into both `start` and `build` commands\n\n### Output\n\nThe plugins are built into a single `dist/index.js` file. The manifest is copied to `dist/plugin-manifest.json` file.\n\n### Deployment\n\n\u003c!-- TO DO --\u003e\n\n### Loading the plugin\n\n**Warning:** While developing, you can use  `https://localhost:3053/plugin-manifest.json` address to load the plugin manifest. Make sure your browser trusts the local certificate on the latter, to be able to use it e.g. with `https://editor.flotiq.com`\n\n#### URL\n\n**Hint**: You can use localhost url from development mode `https://localhost:3053/index.js`\n\n1. Open Flotiq editor\n2. Open Chrome Dev console\n3. Execute the following script\n   ```javascript\n   FlotiqPlugins.loadPlugin('plugin-id', '\u003cURL TO COMPILED JS\u003e')\n   ```\n4. Navigate to the view that is modified by the plugin\n\n#### Directly\n\n1. Open Flotiq editor\n2. Open Chrome Dev console\n3. Paste the content of `dist/index.js` \n4. Navigate to the view that is modified by the plugin\n\n#### Deployment\n\n**Hint**: You can use localhost url from development mode `https://localhost:3053/plugin-manifest.json`\n\n1. Open Flotiq editor\n2. Add a new plugin and paste the URL to the hosted `plugin-manifest.json` file\n3. Navigate to the view that is modified by the plugin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflotiq%2Fflotiq-ui-plugin-chatgpt-faq-generator/lists"}