+This is a Chrome extension that allows you to quickly generate question/answer pairs via GPT-3 and add them to your Anki deck while browsing the web.
-# Chrome Extension (MV3) Boilerplate with React 18 and Webpack 5
+To use it:
-[](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
-[](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
-[](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
+Before installing extension:
+1. Install and configure anki-connect plugin for your desktop Anki client (ankiweb does not provide API access so this is necessary to programmatically insert cards).
+2. Add ankiconnect API key [ankiconnect](/ankiconnect.png)
+ 1. Go to Add Ons Page in Anki
+ 2. Click on AnkiConnect
+ 3. It will pop up a JSON that you can edit. Insert your secret key (something you make up), and then use that same key you made up in the chrome extension. The reason for setting this is because the extension will be talking to your Anki instance, and if we don't set a key than any random website that decides to call localhost at that port will be able to interact with your deck which you don't want.
+3. Obtain an OpenAI API Key if you do not already have one
-## Announcements
+Installing extension:
+1. npm install
+2. npm run dev (you can cancel after the build folder is generated)
+3. go to chrome://extensions, click "load unpacked" button and use the build folder from this repo as the directory to use.
+4. Set the OpenAI key, anki-connect API key, and name of your anki deck in the options page of the Chrome extension (right click on options picture, or see the "Settings" button when you bring it up by selecting text - click on the messages to fill them in)
-- Recently updated from **[React](https://reactjs.org)** ~~17~~ to **18**!
-- **_This boilerplate adopts [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)!_**
- - For V2 users, please check out the [manifest-v2](https://github.com/lxieyang/chrome-extension-boilerplate-react/tree/manifest-v2) branch, or use version [3.x](https://www.npmjs.com/package/chrome-extension-boilerplate-react/v/3.3.0).
- - Check out the [Manifest V3 Migration Guide](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-migration/).
-- Recently added [devtools](https://developer.chrome.com/docs/extensions/mv3/devtools/) Support! Thanks [GeekaholicLin](https://github.com/lxieyang/chrome-extension-boilerplate-react/issues/17)!
-- Recently updated from **[Webpack Dev Server](https://webpack.js.org/configuration/dev-server/)** ~~3.x~~ to **4.x** and **[Webpack](https://webpack.js.org/)** ~~4~~ to **5**!
-- Recently added [TypeScript](https://www.typescriptlang.org/) Support!
+There was a problem with the production webpack build that I couldn't resolve, so I am just using the dev version for now. I will aim to fix it at some point
-## Features
+Happy prompt making!
-This is a basic Chrome Extensions boilerplate to help you write modular and modern Javascript code, load CSS easily and [automatic reload the browser on code changes](https://webpack.github.io/docs/webpack-dev-server.html#automatic-refresh).
+Video of it in action: https://twitter.com/i/status/1621025729013239813
-This boilerplate is updated with:
-- [Chrome Extension Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)
-- [React 18](https://reactjs.org)
-- [Webpack 5](https://webpack.js.org/)
-- [Webpack Dev Server 4](https://webpack.js.org/configuration/dev-server/)
-- [React Refresh](https://www.npmjs.com/package/react-refresh)
-- [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin)
-- [eslint-config-react-app](https://www.npmjs.com/package/eslint-config-react-app)
-- [Prettier](https://prettier.io/)
-- [TypeScript](https://www.typescriptlang.org/)
-
-This boilerplate is heavily inspired by and adapted from [https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate), with additional support for React 18 features, Webpack 5, and Webpack Dev Server 4.
-
-Please open up an issue to nudge me to keep the npm packages up-to-date. FYI, it takes time to make different packages with different versions work together nicely.
-
-## Installing and Running
-
-### Procedures:
-
-1. Check if your [Node.js](https://nodejs.org/) version is >= **18**.
-2. Clone this repository.
-3. Change the package's `name`, `description`, and `repository` fields in `package.json`.
-4. Change the name of your extension on `src/manifest.json`.
-5. Run `npm install` to install the dependencies.
-6. Run `npm start`
-7. Load your extension on Chrome following:
- 1. Access `chrome://extensions/`
- 2. Check `Developer mode`
- 3. Click on `Load unpacked extension`
- 4. Select the `build` folder.
-8. Happy hacking.
-
-## Structure
-
-All your extension's code must be placed in the `src` folder.
-
-The boilerplate is already prepared to have a popup, an options page, a background page, and a new tab page (which replaces the new tab page of your browser). But feel free to customize these.
-
-## TypeScript
-
-This boilerplate now supports TypeScript! The `Options` Page is implemented using TypeScript. Please refer to `src/pages/Options/` for example usages.
-
-## Webpack auto-reload and HRM
-
-To make your workflow much more efficient this boilerplate uses the [webpack server](https://webpack.github.io/docs/webpack-dev-server.html) to development (started with `npm start`) with auto reload feature that reloads the browser automatically every time that you save some file in your editor.
-
-You can run the dev mode on other port if you want. Just specify the env var `port` like this:
-
-```
-$ PORT=6002 npm run start
-```
-
-## Content Scripts
-
-Although this boilerplate uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as [content scripts](https://developer.chrome.com/extensions/content_scripts), but you need to exclude these entry points from hot reloading [(why?)](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/issues/4#issuecomment-261788690). To do so you need to expose which entry points are content scripts on the `webpack.config.js` using the `chromeExtensionBoilerplate -> notHotReload` config. Look the example below.
-
-Let's say that you want use the `myContentScript` entry point as content script, so on your `webpack.config.js` you will configure the entry point and exclude it from hot reloading, like this:
-
-```js
-{
- …
- entry: {
- myContentScript: "./src/js/myContentScript.js"
- },
- chromeExtensionBoilerplate: {
- notHotReload: ["myContentScript"]
- }
- …
-}
-```
-
-and on your `src/manifest.json`:
-
-```json
-{
- "content_scripts": [
- {
- "matches": ["https://www.google.com/*"],
- "js": ["myContentScript.bundle.js"]
- }
- ]
-}
-```
-
-## Intelligent Code Completion
-
-Thanks to [@hudidit](https://github.com/lxieyang/chrome-extension-boilerplate-react/issues/4)'s kind suggestions, this boilerplate supports chrome-specific intelligent code completion using [@types/chrome](https://www.npmjs.com/package/@types/chrome).
-
-## Packing
-
-After the development of your extension run the command
-
-```
-$ NODE_ENV=production npm run build
-```
-
-Now, the content of `build` folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the [official guide](https://developer.chrome.com/webstore/publish) to more infos about publishing.
-
-## Secrets
-
-If you are developing an extension that talks with some API you probably are using different keys for testing and production. Is a good practice you not commit your secret keys and expose to anyone that have access to the repository.
-
-To this task this boilerplate import the file `./secrets.{errorMessage}
+ } + + return ( +
+
+ );
+};
+
+export default Content;
diff --git a/src/components/ContentContainer.stories.tsx b/src/components/ContentContainer.stories.tsx
new file mode 100644
index 000000000..2f389d1e8
--- /dev/null
+++ b/src/components/ContentContainer.stories.tsx
@@ -0,0 +1,29 @@
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
+
+import ContentContainer from './ContentContainer';
+
+// More on default export: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+export default {
+ title: 'ContentContainer',
+ component: ContentContainer,
+ // More on argTypes: https://storybook.js.org/docs/react/api/argtypes
+ argTypes: {
+ backgroundColor: { control: 'color' },
+ },
+} as ComponentMeta{"Anki + LLMs = 🖤"}
+ {isHttps && (
+
)}
+ {!isHttps && (
+
+
+
+ Max number of words: {words}
+
+
+ {question}
+ {!question &&Generated Question
} +
+
+ {answer}
+ {!answer &&Generated Answer
} +
+ {selectedText}
+ {!selectedText &&
+
+
+ {errorDisplay}
+ {apiKeyMessage}
+ {ankiKeyMessage}
+ {ankiDeckMessage}
+
+ Selection
} +HTTPS is required for this extension to work
)} +
+
),
+ _visible: true,
+ _disabled: false,
+};
diff --git a/src/components/ContentContainer.tsx b/src/components/ContentContainer.tsx
new file mode 100644
index 000000000..f40b56752
--- /dev/null
+++ b/src/components/ContentContainer.tsx
@@ -0,0 +1,82 @@
+import React, { useEffect } from "react";
+
+export interface ContentContainerProps {
+ children: React.ReactElement;
+ // For UI testing
+ _visible?: boolean;
+ _disabled?: boolean;
+ _minimized?: boolean;
+}
+
+const closeIcon =
+
+const openIcon =
+
+const xIcon =
+
+
+
+export default function ContentContainer({ children, _visible, _disabled, _minimized }: ContentContainerProps) {
+ // Visibility State
+ const [visible, setVisible] = React.useState(_visible || false);
+ const [disabled, setDisabled] = React.useState(_disabled || false);
+ const [minimized, setMinimized] = React.useState(true);
+
+ // For UI testing
+ useEffect(() => {
+ console.log("visibility changed")
+ setVisible(_visible || false);
+ setDisabled(_disabled || false);
+ setMinimized(_minimized || false);
+ }, [_visible, _disabled, _minimized]);
+
+ const buttonIcon = minimized ? openIcon : closeIcon;
+
+ function handleKeyDown(event: React.KeyboardEventTesting so many differenet things
+Testing so many differenet things
+Testing so many differenet things
+
+
+ );
+}
\ No newline at end of file
diff --git a/src/components/Fakes.tsx b/src/components/Fakes.tsx
new file mode 100644
index 000000000..9171b5297
--- /dev/null
+++ b/src/components/Fakes.tsx
@@ -0,0 +1,19 @@
+function fakeGetStorage(defaults, callback) {
+ callback(defaults);
+ }
+
+export function fakeSetStorage(callback) {
+ callback();
+ }
+
+export const fakeStorage = {
+ get: fakeGetStorage,
+ set: fakeSetStorage
+}
+
+export const fakeRuntime = {
+ onMessage: {
+ addListener: () => null
+ },
+ sendMessage: () => null
+}
\ No newline at end of file
diff --git a/src/components/Options.stories.tsx b/src/components/Options.stories.tsx
new file mode 100644
index 000000000..3e2de04e9
--- /dev/null
+++ b/src/components/Options.stories.tsx
@@ -0,0 +1,24 @@
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
+
+import Options from './Options';
+import { fakeStorage } from './Fakes';
+
+// More on default export: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+export default {
+ title: 'Options',
+ component: Options,
+ // More on argTypes: https://storybook.js.org/docs/react/api/argtypes
+ argTypes: {
+ backgroundColor: { control: 'color' },
+ },
+} as ComponentMeta
+
+
+
+
+
+
+
+
+
+
+ {React.cloneElement(children, { setVisible: setVisible, setDisabled: setDisabled })}
+
+
+
+ }
+
+ return {title}
+ +
+ {setterElement(apiKey, setApiKey, "Open AI API Key")}
+ {setterElement(ankiKey, setAnkiKey, "Anki API Key")}
+ {setterElement(ankiDeck, setAnkiDeck, "Anki Deck")}
+
+
+
;
+};
+
+export default Options;
diff --git a/src/components/TestWebsite.stories.tsx b/src/components/TestWebsite.stories.tsx
new file mode 100644
index 000000000..80da1fce9
--- /dev/null
+++ b/src/components/TestWebsite.stories.tsx
@@ -0,0 +1,30 @@
+import React from 'react';
+import { ComponentStory, ComponentMeta } from '@storybook/react';
+
+import TestWebsite from './TestWebsite';
+import Content from './Content';
+import { fakeRuntime, fakeStorage } from './Fakes';
+
+// More on default export: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
+export default {
+ title: 'TestWebsite',
+ component: TestWebsite,
+ // More on argTypes: https://storybook.js.org/docs/react/api/argtypes
+ argTypes: {
+ backgroundColor: { control: 'color' },
+ },
+} as ComponentMeta
+
+ {children}
+
+
+ }
\ No newline at end of file
diff --git a/src/containers/Greetings/Greetings.jsx b/src/containers/Greetings/Greetings.jsx
deleted file mode 100644
index b0404c860..000000000
--- a/src/containers/Greetings/Greetings.jsx
+++ /dev/null
@@ -1,19 +0,0 @@
-import React, { Component } from 'react';
-import icon from '../../assets/img/icon-128.png';
-
-class GreetingComponent extends Component {
- state = {
- name: 'dev',
- };
-
- render() {
- return (
-
+
+ Lorem Ipsum
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl nec ultricies + tincidunt, nunc nisl aliquam mauris, eget aliquet nisl nunc eget nisl. Sed euismod, nisl nec + ultricies tincidunt, nunc nisl aliquam mauris, eget aliquet nisl nunc eget nisl. Sed euismod, + nisl nec ultricies tincidunt, nunc nisl aliquam mauris, eget aliquet nisl nunc eget nisl. Sed + euismod, nisl nec ultricies tincidunt, nunc nisl aliquam mauris, eget aliquet nisl nunc eget + nisl. Sed euismod, nisl nec ultricies tincidunt, nunc nisl aliquam mauris, eget aliquet nisl + nunc eget nisl. Sed euismod, nisl nec ultricies tincidunt, nunc nisl aliquam mauris, eget + aliquet nisl nunc eget nisl. Sed euismod, nisl nec ultricies tincidunt, nunc nisl aliquam + mauris, eget aliquet nisl nunc eget nisl. Sed euismod, nisl nec ultricies tincidunt, nunc nisl + aliquam mauris, eget aliquet nisl nunc eget nisl. Sed euismod, nisl nec ultricies tincidunt, + nunc nisl aliquam mauris, eget aliquet nisl nunc eget nisl. Sed euismod, nisl nec ultricies + tincidunt, nunc nisl aliquam mauris, eget aliquet nisl nunc eget nisl. Sed euismod, nisl nec +
+
- 
-
- );
- }
-}
-
-export default GreetingComponent;
diff --git a/src/manifest.json b/src/manifest.json
index 9a7ba9080..add153a72 100755
--- a/src/manifest.json
+++ b/src/manifest.json
@@ -1,15 +1,12 @@
{
"manifest_version": 3,
- "name": "Chrome Extension with React & Webpack",
- "description": "A chrome extension boilerplate built with React 17, Webpack 5, and Webpack Dev Server 4",
+ "name": "Anki + LLMs",
+ "description": "Create and add Anki cards while browsing the web, with the aid of LLMs",
"options_page": "options.html",
"background": { "service_worker": "background.bundle.js" },
"action": {
"default_popup": "popup.html",
- "default_icon": "icon-34.png"
- },
- "chrome_url_overrides": {
- "newtab": "newtab.html"
+ "default_icon": "icon-32.png"
},
"icons": {
"128": "icon-128.png"
@@ -17,15 +14,18 @@
"content_scripts": [
{
"matches": ["http://*/*", "https://*/*", "Hello, {this.state.name}!
-{title} Page
;
-};
-
-export default Options;
diff --git a/src/pages/Options/index.css b/src/pages/Options/index.css
index e69de29bb..15e6845d4 100644
--- a/src/pages/Options/index.css
+++ b/src/pages/Options/index.css
@@ -0,0 +1,8 @@
+#app-container {
+ /*all: initial; /*We don't want to inherit anything from the page or injected stylesheets*/
+ /* Manually setting these to counteract Google's injected CSS */
+ /* Google sets to 75%. This scales it back to 100% */
+ font-size: 133.333333333333333333333333%;
+ /* Copied from tailwind file. probably better way to do this */
+ font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+ }
\ No newline at end of file
diff --git a/src/pages/Options/index.jsx b/src/pages/Options/index.jsx
index 49eb68bf5..6b301393f 100644
--- a/src/pages/Options/index.jsx
+++ b/src/pages/Options/index.jsx
@@ -1,9 +1,10 @@
import React from 'react';
import { createRoot } from 'react-dom/client';
-import Options from './Options';
+import Options from '../../components/Options';
+import '../../assets/styles/tailwind.css';
import './index.css';
const container = document.getElementById('app-container');
const root = createRoot(container); // createRoot(container!) if you use TypeScript
-root.render(
-
- 
-
+
- Edit src/pages/Popup/Popup.jsx and save to reload.
-
+ Options
);
};
diff --git a/src/pages/Popup/index.jsx b/src/pages/Popup/index.jsx
index 1d93bbcbb..b81d7a044 100644
--- a/src/pages/Popup/index.jsx
+++ b/src/pages/Popup/index.jsx
@@ -3,7 +3,13 @@ import { createRoot } from 'react-dom/client';
import Popup from './Popup';
import './index.css';
+import '../../assets/styles/tailwind.css';
+
+chrome.tabs.query({currentWindow: true, active: true}, function (tabs){
+ var activeTab = tabs[0];
+ chrome.tabs.sendMessage(activeTab.id, {"message": "popup"});
+});
const container = document.getElementById('app-container');
const root = createRoot(container); // createRoot(container!) if you use TypeScript
root.render(