opscms-waitlist-plugin
v1.0.1
Published
A pre-launch waitlist with a referral queue, for an OpsCMS platform.
Maintainers
Readme
opscms-waitlist-plugin
A pre-launch waitlist with a referral queue. A plugin for the OpsCMS platform, built with opscms-sdk.
waitlist-signups: one row per person on a site's waitlist (unique per site by email, and by invite code). The place in line is worked out from a queue score: it starts as the row's id, and drops by 10 places each time a friend who joined with that person's link confirms their email.- Four internal endpoints on it (
/api/waitlist-signups/join,/confirm,/status,/unsubscribe), called by a storefront's own server with the service secret. Nothing is public. Confirmation links are one-time: a claim the platform lets exactly one request take, so the inviter is credited once. - The confirmation email is written from the site's own
waitlist-confirmationnotification template, so its wording is the site's to edit. The link in it is only ever built for a host the site owns.
A site has a waitlist when it installs the plugin from the Plugins page; a site that has not answers 403.
Install
From the admin: Plugins → Install from npm → opscms-waitlist-plugin. The platform creates the plugin's table (its one migration), lists the plugin
with its logo, and restarts to start it. Removing the plugin drops its table and the sign-ups in it.
The platform currently carries this plugin in its own code under the same key; install the package only after that copy has been removed.
Needs
payload ^3 and opscms-sdk ^0.1.5 (the platform provides both).
Develop
npm install
npm run typecheck && npm test && npm run build && npm pack --dry-runopscms-sdk is linked from a sibling checkout (file:../opscms-sdk) until it is published.
