You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-10Lines changed: 22 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,42 +67,54 @@ While you are not required to use React for your plugin, it must be written in
67
67
Javascript and React is recommended. We support both a standard Javascript API
68
68
and a React Hooks API.
69
69
70
-
#### Create a Project with React
70
+
#### Create a Project with Vite
71
+
72
+
NOTE: Facebook's [create-react-app](https://github.com/facebook/create-react-app) breaks with React 19 (see https://github.com/facebook/create-react-app/issues/17004).
73
+
74
+
You should use [vite](https://github.com/vitejs/vite) instead to create custom plugins.
71
75
72
76
1. Open your terminal and navigate to the directory you want to create your
73
77
project in.
74
-
2. Create your new project. We recommend using Facebook’s
3. Then follow the prompts! You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Vite + Vue project, run:
88
+
89
+
```sh
90
+
yarn create vite my-vue-app --template vue
91
+
```
92
+
93
+
4. Navigate to the project's main directory.
82
94
83
95
```sh
84
96
cd<my-cool-plugin>
85
97
```
86
98
87
-
4. Use your package manager to install Sigma’s plugin library. We recommend
99
+
5. Use your package manager to install Sigma’s plugin library. We recommend
88
100
using `yarn`.
89
101
90
102
```sh
91
103
yarn add @sigmacomputing/plugin
92
104
```
93
105
94
-
5. Spin up your local development server.
106
+
6. Spin up your local development server.
95
107
96
108
```sh
97
-
yarn && yarn start
109
+
yarn && yarn dev
98
110
```
99
111
100
-
6. Start developing:
112
+
7. Start developing:
101
113
102
114
- Get started with Sigma’s Plugin APIs.
103
115
- Test your plugin directly in a Sigma workbook using the Sigma Plugin Dev
104
116
Playground.
105
-
- By default, Create React App dev servers run on http://localhost:3000.
117
+
- By default, Vite dev servers run on http://localhost:5173.
0 commit comments