chore(examples): migrate react-scripts and vue/cli examples to vite (#…

…1264)
algolia · Jul 9, 2024 · 9641523 · 9641523
1 parent 148b677
commit 9641523
Show file tree

Hide file tree

Showing 34 changed files with 419 additions and 5,608 deletions.
diff --git a/examples/react-17/.env b/examples/react-17/.env
diff --git a/examples/react-17/.env.example b/examples/react-17/.env.example
diff --git a/examples/react-17/README.md b/examples/react-17/README.md
@@ -1,46 +1,32 @@
-# Getting Started with Create React App
+# Autocomplete with React 17 example
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This example shows how to integrate Autocomplete with React 17.
 
-## Available Scripts
+## Demo
 
-In the project directory, you can run:
+[Access the demo](https://codesandbox.io/s/github/algolia/autocomplete/tree/next/examples/react-17)
 
-### `yarn start`
+## How to run this example locally
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+### 1. Clone this repository
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+```sh
+git clone git@github.com:algolia/autocomplete.git
+```
 
-### `yarn test`
+### 2. Install the dependencies and run the server
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+```sh
+yarn
+yarn workspace @algolia/autocomplete-example-react-17 start
+```
 
-### `yarn build`
+Alternatively, you may use npm:
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+```sh
+cd examples/react-17
+npm install
+npm start
+```
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+Open <http://localhost:3000> to see your app.
diff --git a/examples/react-17/public/index.html → examples/react-17/index.html b/examples/react-17/public/index.html → examples/react-17/index.html
@@ -1,17 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8" />
+    <meta charset="UTF-8" />
+    <link rel="shortcut icon" type="image/x-icon" href="/favicon.png" />
+    <link rel="manifest" href="/manifest.json" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
-
-    <link rel="icon" href="%PUBLIC_URL%/favicon.png" />
-    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
-
     <title>React 17 | Autocomplete</title>
   </head>
   <body>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
   </body>
 </html>
diff --git a/examples/react-17/package.json b/examples/react-17/package.json
@@ -3,32 +3,31 @@
   "description": "Autocomplete example with React 17",
   "version": "1.17.2",
   "private": true,
+  "scripts": {
+    "dev": "vite",
+    "start": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
+  },
   "dependencies": {
     "@algolia/autocomplete-core": "1.17.2",
     "@algolia/autocomplete-preset-algolia": "1.17.2",
     "@algolia/autocomplete-theme-classic": "1.17.2",
-    "@algolia/client-search": "4.16.0",
     "algoliasearch": "4.16.0",
     "react": "17.0.2",
-    "react-dom": "17.0.2",
-    "react-scripts": "4.0.3"
+    "react-dom": "17.0.2"
   },
-  "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
+  "devDependencies": {
+    "@algolia/client-search": "4.16.0",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "@vitejs/plugin-react": "1.0.7",
+    "typescript": "^4.4.2",
+    "vite": "2.8.0"
   },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  }
+  "keywords": [
+    "algolia",
+    "autocomplete",
+    "react"
+  ]
 }
diff --git a/examples/react-17/react-app-env.d.ts b/examples/react-17/react-app-env.d.ts
diff --git a/examples/react-17/src/react-app-env.d.ts b/examples/react-17/src/react-app-env.d.ts
diff --git a/examples/react-17/vite.config.ts b/examples/react-17/vite.config.ts
@@ -0,0 +1,7 @@
+import react from '@vitejs/plugin-react';
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/examples/react-instantsearch/README.md b/examples/react-instantsearch/README.md
@@ -20,13 +20,13 @@ git clone git@github.com:algolia/autocomplete.git
 
 ```sh
 yarn
-yarn workspace @algolia/autocomplete-example-react-instantsearch-hooks dev
+yarn workspace @algolia/autocomplete-example-react-instantsearch dev
 ```
 
 Alternatively, you may use npm:
 
 ```sh
-cd examples/react-instantsearch-hooks
+cd examples/react-instantsearch
 npm install
 npm run dev
 ```

diff --git a/examples/react/.env b/examples/react/.env
diff --git a/examples/react/.env.example b/examples/react/.env.example
diff --git a/examples/react/public/index.html → examples/react/index.html b/examples/react/public/index.html → examples/react/index.html
@@ -1,14 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8" />
-    <link rel="icon" href="%PUBLIC_URL%/favicon.png" />
+    <meta charset="UTF-8" />
+    <link rel="shortcut icon" type="image/x-icon" href="/favicon.png" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
     <title>React | Autocomplete</title>
   </head>
   <body>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
   </body>
 </html>
diff --git a/examples/react/package.json b/examples/react/package.json
@@ -5,8 +5,10 @@
   "private": true,
   "license": "MIT",
   "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build"
+    "dev": "vite",
+    "start": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
   },
   "dependencies": {
     "@algolia/autocomplete-js": "1.17.2",
@@ -19,24 +21,13 @@
     "@algolia/client-search": "4.16.0",
     "@types/react": "^18.0.26",
     "@types/react-dom": "^18.0.9",
-    "react-scripts": "4.0.3",
-    "typescript": "^4.4.2"
+    "@vitejs/plugin-react": "1.0.7",
+    "typescript": "^4.4.2",
+    "vite": "2.8.0"
   },
-  "eslintConfig": {
-    "extends": [
-      "react-app"
-    ]
-  },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  }
+  "keywords": [
+    "algolia",
+    "autocomplete",
+    "react"
+  ]
 }
diff --git a/examples/react/src/react-app-env.d.ts b/examples/react/src/react-app-env.d.ts
diff --git a/examples/react/vite.config.ts b/examples/react/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/examples/slack-with-emojis-and-commands/.env.example b/examples/slack-with-emojis-and-commands/.env.example
diff --git a/examples/slack-with-emojis-and-commands/index.html b/examples/slack-with-emojis-and-commands/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="shortcut icon" type="image/x-icon" href="/favicon.png" />
+    <link rel="manifest" href="/manifest.json" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <title>Slack with emojis and slash commands | Autocomplete</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
+  </body>
+</html>
diff --git a/examples/slack-with-emojis-and-commands/package.json b/examples/slack-with-emojis-and-commands/package.json
@@ -5,39 +5,31 @@
   "private": true,
   "license": "MIT",
   "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "dev": "vite",
+    "start": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
   },
   "dependencies": {
     "@algolia/autocomplete-core": "1.17.2",
     "@algolia/autocomplete-preset-algolia": "1.17.2",
     "algoliasearch": "4.16.0",
     "react": "17.0.2",
     "react-dom": "17.0.2",
-    "react-scripts": "4.0.3",
     "textarea-caret": "3.1.0"
   },
   "devDependencies": {
     "@algolia/client-search": "4.16.0",
-    "@types/textarea-caret": "3.0.1"
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "@types/textarea-caret": "3.0.1",
+    "@vitejs/plugin-react": "1.0.7",
+    "typescript": "^4.4.2",
+    "vite": "2.8.0"
   },
   "keywords": [
     "algolia",
     "autocomplete",
     "javascript"
-  ],
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  }
+  ]
 }
diff --git a/examples/slack-with-emojis-and-commands/react-app-env.d.ts b/examples/slack-with-emojis-and-commands/react-app-env.d.ts
diff --git a/examples/slack-with-emojis-and-commands/src/react-app-env.d.ts b/examples/slack-with-emojis-and-commands/src/react-app-env.d.ts
diff --git a/examples/slack-with-emojis-and-commands/vite.config.ts b/examples/slack-with-emojis-and-commands/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/examples/twitter-compose-with-typeahead/.env.example b/examples/twitter-compose-with-typeahead/.env.example
diff --git a/...-compose-with-typeahead/public/index.html → ...twitter-compose-with-typeahead/index.html b/...-compose-with-typeahead/public/index.html → ...twitter-compose-with-typeahead/index.html
@@ -1,17 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8" />
+    <meta charset="UTF-8" />
+    <link rel="shortcut icon" type="image/x-icon" href="/favicon.png" />
+    <link rel="manifest" href="/manifest.json" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
-
-    <link rel="icon" href="%PUBLIC_URL%/favicon.png" />
-    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
-
     <title>Twitter compose box with mentions typeahead | Autocomplete</title>
   </head>
   <body>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
   </body>
 </html>