♻️ Add proper examples (#92)

* 🗑️ Delete all current examples * 📚 Add hello-world-haiku example * 📚 Add chatgpt clone example * 🗑️ Remove auto-generated README.md * 📚 Add warning to change project slug in chat example
polyfact · Oct 23, 2023 · 052cf4d · 052cf4d
1 parent efe79dd
commit 052cf4d
Show file tree

Hide file tree

Showing 64 changed files with 21,411 additions and 1,455 deletions.
diff --git a/examples/calculator.ts b/examples/calculator.ts
diff --git a/examples/chatgpt-clone/.gitignore b/examples/chatgpt-clone/.gitignore
@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/examples/chatgpt-clone/package.json b/examples/chatgpt-clone/package.json
@@ -0,0 +1,48 @@
+{
+    "name": "chatgpt-clone",
+    "version": "0.1.0",
+    "private": true,
+    "dependencies": {
+        "@testing-library/jest-dom": "^5.17.0",
+        "@testing-library/react": "^13.4.0",
+        "@testing-library/user-event": "^13.5.0",
+        "@types/jest": "^27.5.2",
+        "@types/node": "^16.18.59",
+        "@types/react": "^18.2.31",
+        "@types/react-dom": "^18.2.14",
+        "polyfire-js": "file:../../dist",
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0",
+        "react-scripts": "5.0.1",
+        "typescript": "^4.9.5",
+        "web-vitals": "^2.1.4"
+    },
+    "scripts": {
+        "start": "react-scripts start",
+        "build": "react-scripts build",
+        "test": "react-scripts test",
+        "eject": "react-scripts eject",
+        "preinstall": "cd ../../ && npm install && npm run build"
+    },
+    "eslintConfig": {
+        "extends": [
+            "react-app",
+            "react-app/jest"
+        ]
+    },
+    "browserslist": {
+        "production": [
+            ">0.2%",
+            "not dead",
+            "not op_mini all"
+        ],
+        "development": [
+            "last 1 chrome version",
+            "last 1 firefox version",
+            "last 1 safari version"
+        ]
+    },
+    "devDependencies": {
+        "tailwindcss": "^3.3.3"
+    }
+}
diff --git a/examples/chatgpt-clone/public/favicon.ico b/examples/chatgpt-clone/public/favicon.ico
diff --git a/examples/chatgpt-clone/public/index.html b/examples/chatgpt-clone/public/index.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/examples/chatgpt-clone/public/logo192.png b/examples/chatgpt-clone/public/logo192.png
diff --git a/examples/chatgpt-clone/public/logo512.png b/examples/chatgpt-clone/public/logo512.png
diff --git a/examples/chatgpt-clone/public/manifest.json b/examples/chatgpt-clone/public/manifest.json
@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/examples/chatgpt-clone/public/robots.txt b/examples/chatgpt-clone/public/robots.txt
@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:
diff --git a/examples/chatgpt-clone/src/App.css b/examples/chatgpt-clone/src/App.css
@@ -0,0 +1,38 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  height: 40vmin;
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .App-logo {
+    animation: App-logo-spin infinite 20s linear;
+  }
+}
+
+.App-header {
+  background-color: #282c34;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #61dafb;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
diff --git a/examples/chatgpt-clone/src/App.test.tsx b/examples/chatgpt-clone/src/App.test.tsx
@@ -0,0 +1,9 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import App from './App';
+
+test('renders learn react link', () => {
+  render(<App />);
+  const linkElement = screen.getByText(/learn react/i);
+  expect(linkElement).toBeInTheDocument();
+});
diff --git a/examples/chatgpt-clone/src/App.tsx b/examples/chatgpt-clone/src/App.tsx
@@ -0,0 +1,41 @@
+import React from "react";
+import { usePolyfire, useChat } from "polyfire-js/hooks";
+import ChatBox from "./ChatBox";
+
+function App() {
+    const {
+        auth: { login, status },
+    } = usePolyfire();
+    const { messages, sendMessage, loading } = useChat();
+
+    return (
+        <>
+            {status === "unauthenticated" ? (
+                <div>
+                    <h1 className="font-bold">
+                        Don't forget to change the project slug in src/index.tsx
+                    </h1>
+                    <p>
+                        After that you will be able to{" "}
+                        <button
+                            className="cursor-pointer bg-black text-white ml-1 p-1 px-5 font-mono-font-bold"
+                            onClick={() => login("github")}
+                        >
+                            Login With GitHub
+                        </button>
+                    </p>
+                </div>
+            ) : status === "authenticated" ? (
+                <ChatBox
+                    messages={messages?.slice().reverse() || []}
+                    onMessage={sendMessage}
+                    loading={loading}
+                />
+            ) : (
+                "Loading..."
+            )}
+        </>
+    );
+}
+
+export default App;
diff --git a/examples/chatgpt-clone/src/ChatBox.tsx b/examples/chatgpt-clone/src/ChatBox.tsx
@@ -0,0 +1,53 @@
+import React, { FormEvent } from "react";
+
+function ChatBox({
+    messages,
+    onMessage,
+    loading,
+}: {
+    messages: { is_user_message: boolean; content: string }[];
+    onMessage: (message: string) => Promise<void> | void;
+    loading: boolean;
+}) {
+    async function handleSubmit(e: FormEvent<HTMLFormElement>) {
+        e.preventDefault();
+
+        const message = (e.target as any).message.value;
+        if (message) {
+            (e.target as any).message.value = "";
+            await onMessage(message);
+        }
+    }
+
+    return (
+        <div className="flex flex-col items-center h-full py-2">
+            <div className="border-black border border-solid p-4 mb-2 w-[800px] grow overflow-y-scroll">
+                <pre>
+                    {messages.map((elem) => (
+                        <p className="whitespace-pre-wrap">
+                            <b>{elem.is_user_message ? "Human:" : "AI:"}</b> {elem.content}
+                        </p>
+                    ))}
+                </pre>
+            </div>
+            <form onSubmit={handleSubmit} className="flex w-[800px]">
+                <div className="flex grow items-center border-black border border-solid">
+                    <div className="font-bold ml-4">Human:</div>
+                    <input
+                        className="p-1 my-2 mx-4 h-12 font-mono grow"
+                        placeholder="Type your message here !"
+                        name="message"
+                    />
+                </div>
+                <input
+                    className="cursor-pointer bg-black text-white ml-2 p-2 px-5 font-mono font-bold"
+                    value={loading ? "Loading..." : "Send >"}
+                    type="submit"
+                    disabled={loading}
+                />
+            </form>
+        </div>
+    );
+}
+
+export default ChatBox;
diff --git a/examples/chatgpt-clone/src/index.css b/examples/chatgpt-clone/src/index.css
@@ -0,0 +1,9 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+html, body, #root {
+    width: 100%;
+    height: 100%;
+    margin: 0;
+}
diff --git a/examples/chatgpt-clone/src/index.tsx b/examples/chatgpt-clone/src/index.tsx
@@ -0,0 +1,14 @@
+import ReactDOM from "react-dom/client";
+import { PolyfireProvider } from "polyfire-js/hooks";
+import "./index.css";
+import App from "./App";
+import reportWebVitals from "./reportWebVitals";
+
+const root = ReactDOM.createRoot(document.getElementById("root") as HTMLElement);
+root.render(
+    <PolyfireProvider project="your_project_slug_here">
+        <App />
+    </PolyfireProvider>,
+);
+
+reportWebVitals();
diff --git a/examples/chatgpt-clone/src/logo.svg b/examples/chatgpt-clone/src/logo.svg
diff --git a/examples/chatgpt-clone/src/react-app-env.d.ts b/examples/chatgpt-clone/src/react-app-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="react-scripts" />
diff --git a/examples/chatgpt-clone/src/reportWebVitals.ts b/examples/chatgpt-clone/src/reportWebVitals.ts
@@ -0,0 +1,15 @@
+import { ReportHandler } from 'web-vitals';
+
+const reportWebVitals = (onPerfEntry?: ReportHandler) => {
+  if (onPerfEntry && onPerfEntry instanceof Function) {
+    import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
+      getCLS(onPerfEntry);
+      getFID(onPerfEntry);
+      getFCP(onPerfEntry);
+      getLCP(onPerfEntry);
+      getTTFB(onPerfEntry);
+    });
+  }
+};
+
+export default reportWebVitals;
diff --git a/examples/chatgpt-clone/src/setupTests.ts b/examples/chatgpt-clone/src/setupTests.ts
@@ -0,0 +1,5 @@
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+import '@testing-library/jest-dom';
diff --git a/examples/chatgpt-clone/tailwind.config.js b/examples/chatgpt-clone/tailwind.config.js
@@ -0,0 +1,8 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+    content: ["./src/**/*.{js,jsx,ts,tsx}"],
+    theme: {
+        extend: {},
+    },
+    plugins: [],
+};
diff --git a/examples/chatgpt-clone/tsconfig.json b/examples/chatgpt-clone/tsconfig.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx"
+  },
+  "include": [
+    "src"
+  ]
+}