Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tryghost/sdk

Tools for working with Ghost's APIs
https://github.com/tryghost/sdk

api hacktoberfest javascript nodejs rest-api

Last synced: 4 days ago
JSON representation

Tools for working with Ghost's APIs

Awesome Lists containing this project

README

        

# Ghost SDK

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

## Develop

This is a mono repository, managed with [lerna](https://lerna.js.org/).

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](https://github.com/TryGhost/slimer)
- run `slimer new `

## 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/SDK and original repository is set to `upstream`.

# Copyright & License

Copyright (c) 2013-2023 Ghost Foundation - Released under the [MIT license](LICENSE).