@rishabhgrg/membersjs-test
v0.1.10
Published
Drop-in script to make the bulk of members work on any theme
Downloads
4
Readme
Members.js
Drop-in script to make the bulk of members work on any theme
Basic Setup
- Clone this repository:
[email protected]:TryGhost/members.js.git
- Change into the new directory and install the dependencies:
cd members.js
yarn
Configure for local development
In your local Ghost setup:
- Add
rish-upstream
as remote on your local Ghost repo -
git remote add rish-upstream [email protected]:rishabhgrg/Ghost.git
- Fetch and checkout membersjs branch from the remote -
git fetch rish-upstream membersjs && git checkout membersjs
- Ensure your local Ghost is running
In this repo(Members.js):
- Run
yarn build
to create the minified bundle with your changes atumd/members.min.js
In your theme(Ex. Lyra):
- Copy
members.min.js
from above and paste it in your theme atassets/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>
// Pass Admin URL
var data = {
adminUrl: window.location.origin + "/ghost",
};
// Initialize members.js
window.GhostMembers.initMembersJS(data);
</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
Before shipping, please ensure the intended version is updated in package.json
.
- Run
npm publish --access public
to ship the new version to npm and unpkg.- 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
- Builds the script with latest code using
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.