sp-dev-fx-webparts/samples/react-chat-gpt
Hugo Bernier a658d92462
Merge pull request #4835 from pnp/dependabot/npm_and_yarn/samples/react-chat-gpt/follow-redirects-1.15.6
2024-03-25 22:09:07 -04:00
..
.devcontainer Added sample.json and container 2023-02-08 23:44:25 -05:00
assets Added sample.json and container 2023-02-08 23:44:25 -05:00
config
src Updated styling, removed logging 2023-02-05 22:07:39 +01:00
teams
.eslintrc.js
.gitignore
.npmignore
.yo-rc.json
README.md Updated links to devprogram 2024-02-06 11:16:44 -05:00
gulpfile.js
package-lock.json Merge pull request #4835 from pnp/dependabot/npm_and_yarn/samples/react-chat-gpt/follow-redirects-1.15.6 2024-03-25 22:09:07 -04:00
package.json Bump axios and openai in /samples/react-chat-gpt 2023-11-11 03:05:45 +00:00
tsconfig.json

README.md

Chat GPT inside SPFx

Summary

This webpart uses Chat GPT in an SPFx web part. You can ask questions from the web part and you will see the answers, most recent answers first.

Example animated screen

Example loading screen

Example screen

Example no api key screen

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

This sample is optimally compatible with the following environment configuration:

SPFx 1.16.1 Node.js v16 | v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Contributors

Version history

Version Date Comments
1.0 February 4, 2023 Initial release

Prerequisites

This web part needs a Chat GPT api key, which you can get in the settings of the https://platform.openai.com environment. (Click on your profile in the top right corner and then click on 'view API keys').

You must then enter this api key in the web part properties

Minimal path to awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-chat-gpt, located under samples)
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.