Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Added .github folder and files from main repo Feb 12, 2019
packages Update dependency rollup to v1.15.6 Jun 17, 2019
test Initial commit Oct 3, 2018
.editorconfig Initial commit Oct 3, 2018
.gitignore 💄 Fixed repo naming Oct 9, 2018
.travis.yml
LICENSE 2019 Jan 1, 2019
README.md
SECURITY.md Added SECURITY.md Feb 11, 2019
index.js Initial commit Oct 3, 2018
lerna.json Initial commit Oct 3, 2018
package.json Update dependency eslint-plugin-react to v7.13.0 May 6, 2019
renovate.json Update Renovate Configuration Apr 17, 2019
yarn.lock

README.md

Ghost SDK

A collection of tools for interacting with Ghost's APIs.

Develop

This is a mono repository, managed with lerna.

  1. git clone this repo & cd into it as usual
  2. yarn setup is mapped to lerna bootstrap
    • installs all external dependencies
    • links all internal dependencies

To add a new package to the repo:

  • install slimer
  • run slimer new <package name>

Run

  • yarn dev

Test

  • yarn lint run just eslint
  • yarn test run lint and tests

Publish

  • yarn ship is an alias for lerna publish
    • Publishes all packages which have changed
    • Also updates any packages which depend on changed packages

NOTE: use yarn ship --git-remote upstream to correctly update tags and version commits, when your remote origin is set up to a fork of TryGhost/Ghost-SDK and original repository is set to upstream.

Copyright & License

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

You can’t perform that action at this time.