Rish 9edb3d2e58 Reworded usage section in readme

Simple rewording to make usage section shorter and to point

2020-04-29 13:38:29 +05:30

3.2 KiB

Raw Blame History

Members.js

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

Usage

Add below code in your theme's default.hbs 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>
<script>
    // Initializes members.js
    // adminUrl: Your API domain (Ref: https://ghost.org/docs/api/v3/javascript/admin/#authentication)
    window.GhostMembers.init({
      adminUrl: 'https://youradminurl.com'
    });
</script>

Basic Setup

Clone this repository:

git@github.com:TryGhost/members.js.git

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 above {{{block "scripts"}}} to add and initialize members script

<script src="{{asset "built/members.min.js"}}"></script>
<script>
    // Initialize members.js
    window.GhostMembers.init({
        adminUrl: 'youradminurl.com'
    });
</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.

Note: You'll need to configure the local Admin API url for script initialization.

Copy .env.development.local.example to .env.development.local
Update the values to match your local dev version of Ghost

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

3.2 KiB Raw Blame History