Ghost/ghost/portal
Rish 2b34ee5c28 Updated paid signup action of member to include name
refs https://github.com/TryGhost/members.js/issues/29

- Uses updated API endpoint for checkout to pass member name in stripe checkout session metadata
2020-05-20 00:14:21 +05:30
..
.github/workflows Added basic github workflow for running tests 2020-04-10 16:42:25 +01:00
public Initialize project using Create React App 2020-03-24 18:37:04 +05:30
scripts Updated build process for single minified script 2020-03-24 18:49:04 +05:30
src Updated paid signup action of member to include name 2020-05-20 00:14:21 +05:30
.editorconfig Initial commit 2020-03-24 18:37:38 +05:30
.env Switched to recommended absolute test-utils path setup 2020-04-28 23:29:56 +05:30
.env.development.local.example Updated local env file example to use default page 2020-05-01 22:21:44 +05:30
.gitignore Allowed .env file in source control for test-utils setup 2020-04-28 23:15:09 +05:30
LICENSE Initial commit 2020-03-24 18:37:38 +05:30
package.json Update dependency eslint-plugin-ghost to v1.4.1 2020-05-11 10:15:34 +00:00
README.md Updated script usage in readme to remove explicit init and adminUrl 2020-05-01 17:10:17 +05:30
renovate.json Updated Renovate config 2020-04-13 10:46:29 +01:00
webpack.config.js Updated build and publish setup for unpkg deployment 2020-04-20 22:10:58 +05:30
yarn.lock Update dependency eslint-plugin-ghost to v1.4.1 2020-05-11 10:15:34 +00:00

Members.js

CI Status npm version

Drop-in script to make the bulk of members work on any theme.

Usage

Add below script in your theme's default.hbs just before the end of body tag OR in the code injection footer in Ghost Admin.

<script type="text/javascript" src="https://unpkg.com/@tryghost/members-js@latest/umd/members.min.js"></script>

Basic Setup

  1. Clone this repository:
git@github.com:TryGhost/members.js.git
  1. Change into the new directory and install the dependencies:
cd members.js
yarn

Configure for local development

Only useful for active UI development without publishing a version on unpkg. Always use the unpkg link for testing latest released members.js.

In this repo(Members.js):

  • Run yarn build to create the minified bundle with your changes at umd/members.min.js

In your theme(Ex. Lyra):

  • Copy members.min.js from above and paste it in your theme at assets/built/members.min.js
  • Add below code in your theme's default.hbs just before end of body tag
<script src="{{asset "built/members.min.js"}}"></script>

Available Scripts

In the project directory, you can also run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn build

Creates the production single minified bundle for external use in umd/members.min.js.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Publish

  • yarn ship is an alias for npm publish
    • Before shipping, please ensure the intended version is updated in package.json.
    • Builds the script with latest code using yarn build (prePublish)
    • Publishes package on npm as @tryghost/members-js and creates an unpkg link for script at https://unpkg.com/@tryghost/members-js@VERSION

Learn More

This project was bootstrapped with Create React App. You can learn more in the Create React App documentation.

Copyright & License

Copyright (c) 2020 Ghost Foundation - Released under the MIT license.