Back to docs

Installation

There are two ways to install GJS Builder: a ready-to-run release ZIP (no build tools needed) or a from-source build for contributors.

Requirements

RequirementVersion
WordPress6.4+ (tested to 6.8)
PHP8.0+
Node.js18+ (only to build from source)

The plugin ships with a lightweight autoloader, so there is no composer install step at runtime.

  1. Download the release ZIP.
  2. In wp-admin, go to Plugins → Add New → Upload Plugin.
  3. Choose the ZIP and click Install Now, then Activate.

That's it — no Node, no build step. Continue with Getting started.

Option B — build from source

git clone <repo-url> gjs-builder
cd gjs-builder
npm install
npm run build

Then copy the folder into wp-content/plugins/ and activate it in wp-admin. Build tooling is Vite 6; npm run dev watches, npm run build compiles, and npm run zip packages a release.

First run

On activation the plugin registers the Landings post type and its admin menu (Landings → Extensions / Presets / Settings). It does not modify your existing posts, pages or theme.

Serving the editor engine locally

The GrapesJS engine is served from your own server, never a CDN at runtime. In Settings you can pick a curated core version and download it to the server. See Settings & performance for why this matters.

Uninstalling

By default, uninstalling keeps your data — pages remain as HTML in post_content and keep rendering through your theme. There is an opt-in "delete data on uninstall" setting if you truly want a clean removal.