This template is based on the default template created by the webflow-cli, but extended and modified to host and bundle a React application using Vite.
See Webflow's documentation for more information about Designer Extension APIs.
To create a project from this template, select “Use this template“ → “Create new repository“ on the GitHub page of this template.
See “Developing“ below to see which scripts to use to get started.
Here is an overview over the most important directories and files:
├──src/ — React application code
├──public/ — Output folder for bundled React app (see note below)
├──index.html — The index file which will be used as an entry point by the bundler
├──tsconfig.json — A modified tsconfig which combines JSX support, Webflow types, and sensible React defaults.
├──vite.config.ts — Configuration for the bundler
├──webflow.json — Webflow App manifest
This template includes a suggested Prettier configuration in .prettierrc and uses Yarn by default.
Run this command in your terminal in the project root directory to install its dependencies:
yarn
yarn dev
The above command does a few things:
- Watches for changes in the
src/folder and bundles the React application in thepublic/folder, as required by the Webflow CLI for bundling. - Spins up a process that serves your extension files from under
public/
The command outputs the URL under which your extension is being served. Use this as the “Development URL” for your app in the Webflow Designer’s Apps panel. You can then launch the extension from the same place.
yarn build
This will take the contents of the ./public folder and prepare a bundle.zip file ready for you to upload as a Designer extension for your App.
Vite is configured to use the public/ folder as the output, as this is where the webflow-cli expects the final assets for deployment, including scripts and the index.html file.
If you put any assets manually in the public/ folder, they will be overriden during buliding.
The source code of the webflow-app-template-react template is available for use under the MIT license. See license