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: 15 days ago
JSON representation

Tools for working with Ghost's APIs

• Host: GitHub
• URL: https://github.com/tryghost/sdk
• Owner: TryGhost
• License: mit
• Created: 2018-08-23T07:59:48.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T07:30:49.000Z (7 months ago)
• Last Synced: 2024-04-14T04:18:41.869Z (7 months ago)
• Topics: api, hacktoberfest, javascript, nodejs, rest-api
• Language: JavaScript
• Homepage:
• Size: 16.9 MB
• Stars: 108
• Watchers: 18
• Forks: 71
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md
  • Support: .github/SUPPORT.md

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