https://github.com/promptable/gpt3-chrome-starter
GPT3 Chrome Extension Starter Kit
https://github.com/promptable/gpt3-chrome-starter
Last synced: about 1 year ago
JSON representation
GPT3 Chrome Extension Starter Kit
- Host: GitHub
- URL: https://github.com/promptable/gpt3-chrome-starter
- Owner: promptable
- Created: 2023-01-15T01:21:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T03:06:53.000Z (over 3 years ago)
- Last Synced: 2025-05-08T02:03:26.384Z (about 1 year ago)
- Language: TypeScript
- Size: 341 KB
- Stars: 17
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GOTCHAS
if you update the content script, you might need to refresh the extension in the chrome 'manage extensions' page
# Environment
add the following to `.env.local`
```
OPENAI_API_KEY=
```
This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
## Getting Started
First, run the development server:
```bash
pnpm dev
# or
npm run dev
```
Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
For further guidance, [visit our Documentation](https://docs.plasmo.com/)
## Making production build
Run the following:
```bash
pnpm build
# or
npm run build
```
This should create a production bundle for your extension, ready to be zipped and published to the stores.
## Submit to the webstores
The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission!
### Local Testing
To test the Chrome extension locally:
- Open chrome://extensions/
- Click "Load unpacked"
- Navigate to this repo's copy
- Click "Select"
- Navigate to the Chrome Plugins
- Open Gpt Plasmo starter