Ghost/ghost/signup-form
Fabien 'egg' O'Carroll 32f4861176
Bumped eslint-plugin-ghost (#16906)
- This includes changes to support PascalCase filenames for interfaces
- Also bumps newer packages to use the latest version to avoid conflicts
with the underlying eslint-plugin-filenames package
2023-05-31 16:36:32 -04:00
..
.storybook
src Fixed linter failing due to Tailwind class ordering 2023-05-30 15:58:58 +02:00
test Fixed labels for signup form 2023-05-30 14:06:25 +02:00
.env.development Fixed default Ghost url in dev environment 2023-05-23 17:11:04 +02:00
.eslintrc.cjs
.yarnrc
index.html Fixed old label usage of signup form demo 2023-05-30 14:10:27 +02:00
package.json Bumped eslint-plugin-ghost (#16906) 2023-05-31 16:36:32 -04:00
playwright.config.ts Added Playwright tests to Signup Form 2023-05-24 15:06:44 +02:00
postcss.config.cjs
preview.html Fixed old label usage of signup form demo 2023-05-30 14:10:27 +02:00
README.md Added Playwright tests to Signup Form 2023-05-24 15:06:44 +02:00
tailwind.config.cjs
tsconfig.json
tsconfig.node.json
vite.config.ts Added signup-form package (#16846) 2023-05-23 14:58:33 +02:00

Embeddable Signup Form

Embed a Ghost signup form on any site.

Development

Pre-requisites

  • Run yarn in Ghost monorepo root
  • Run yarn in this directory

Running the development version

Run yarn dev to start the development server to test/develop the form standalone.

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 workaroudn 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.

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

Test

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