Development

Pre-requisites

Run pnpm in Ghost monorepo root
Run pnpm in this directory

Running via Ghost `pnpm dev` in root folder

Signup Form runs automatically when using Ghost's development command from the monorepo root:

pnpm dev

This starts all frontend apps (including Signup Form.)

Running the development version only

Run pnpm dev (in package folder) to start the development server to test/develop the form standalone.

This will generate a demo site on http://localhost:6173
This will build and watch the production build and host it on http://localhost:6174/signup-form.min.js (different port!)

Using the UMD build during development

Vite by default only supports HRM with an ESM output. But when loading a script on a site as a ESM module (<script type="module" src="...">), you don't have access to document.currentScript inside the script, which is required to determine the location to inject the iframe. In development mode we use a workaround for this to make the ESM HMR work. But this workaround is not suitable for production.

To test the real production behaviour without this hack, you can use http://localhost:6173/preview.html. This HTML page will use http://localhost:6174/signup-form.min.js directly.

Develop

This is a monorepo package.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run pnpm to install top-level dependencies.

Test

pnpm lint run just eslint
pnpm test run lint and tests
pnpm test:e2e run e2e tests on Chromium
pnpm test:slowmo run e2e tests visually (headed) and slower on Chromium
pnpm test:e2e:full run e2e tests on all browsers

Release

A patch release can be rolled out instantly in production, whereas a minor/major release requires the Ghost monorepo to be updated and released. In either case, you need sufficient permissions to release @tryghost packages on NPM.

Patch release

Run pnpm ship and select a patch version when prompted
Merge the release commit to main

Minor / major release

Run pnpm ship and select a minor or major version when prompted
Merge the release commit to main
Wait until a new version of Ghost is released

To use the new version of signup form in Ghost, update the version in Ghost core's default configuration (currently at core/shared/config/default.json)

2.5 KiB Raw Permalink Blame History

Embeddable Signup Form