Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 1.75 KB

README.md

File metadata and controls

73 lines (48 loc) · 1.75 KB
Raw

Example App Plugin - Campaign Builder

👉 See here for the main plugin entry and configuration

Getting started

Install

git clone https://github.com/BuilderIO/builder.git
cd plugins/example-simple-app
npm install

Develop

npm start

Add the plugin in Builder.io

From builder.io open the javascript console in your browser's dev tools and run.

// Adds the plugin
builder.plugins.replace(['http://localhost:1268/plugin.system.js'])
// Saves for all in your organization and reloads the browser
builder.savePlugins().then(() => location.reload())

NOTE: Loading http:// content on an https:// website will give you a warning. Be sure to click the shield in the top right of your browser and choose "load unsafe scripts" to allow the http content on Builder's https site when devloping locally

Load unsafe script example

Now as you develop you can restart Builder to see the latest version of your plugin.

To uninstall your plugin run

// Removes all plugins
builder.plugins.replace([])
// Saves for all in your organization and reloads the browser
builder.savePlugins().then(() => location.reload())

Publishing

We recommend sending us a pull request with your plugin so we can publish it on your behalf.

If required, you can also publish to your own NPM or a hosting service.

To load a plugin from NPM

builder.plugins.replace(['@builder.io/plugin-example'])

Advanced

You can load a plugin from a specific version

builder.plugins.replace(['@builder.io/[email protected]'])

Or from a URL

builder.plugins.replace(['https://something.com/foo'])