Deployments

CDN version

The CDN version of Brizy is hosted on Brizy's servers. Choose this version if you don't want to host the editor. This will let you initialise the editor on your side, but Brizy will host it on its CDN infrastructure.

For more information on how to use the CDN version of the Editor check the packages/core file.

Self-hosted version

The Self-hosted version of Brizy is hosted by you. Choose this version if you want to host the editor locally on your server.

For more information on how to use the Self-hosted version of the Editor check the README packages/core or view the demo in packages/demo

Vercel

You can deploy a fresh Brizy project, with a Git repository set up for you, with the following Deploy Button:

Third Party

Creating an App

npx @brizy/create-thirdparty
cd < my-app >
npm run build

Read more about Third Party.

Usage

After building the third-party library, you can send it to the editor configuration via HTTP URLs. Here's how you can do it:

1. Host the built library files on a server accessible via HTTP.
2. Get the host URL and the path folder where the config.json file is located.
3. Add the extensions key to the editor configuration with the following structure:

const config = {
  // Other config keys...

  extensions: [
    {
      host: "http://<your-library-build-host>",
      path: "<path-to-config-folder>",
    },
  ],
};

Example:

If config.json is located at http://localhost:3000/widgets/config.json, the configuration will look like this:

const config = {
  // Other config keys...

  extensions: [
    {
      host: "http://localhost:3000",
      path: "/widgets",
    },
  ],
};

The config.json file should follow this structure:

{
  "name": "My Library",
  "editorScripts": [
    // List of scripts for the editor
  ],
  "editorStyles": [
    // List of styles for the editor
  ],
  "viewScripts": [
    // List of scripts for the view
  ],
  "viewStyles": [
    // List of styles for the view
  ]
}

For more information about the config