# netlify-cms-backend-github

> GitHub backend for Netlify CMS

Latest version **2.14.1** (published 2022-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install netlify-cms-backend-github
pnpm add netlify-cms-backend-github
yarn add netlify-cms-backend-github
bun add netlify-cms-backend-github
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.14.1 |
| Published | 2022-04-13 |
| First published | 2018-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19392 |
| Maintainers | orinokai, ericap, seanroberts, dustincrogers, skn0tt, mikewen, dengeist, biilmann, marcus.netlify, erezro, jgantunes, eduardoboucas, netlify-bot, nasiba, zachleat, ascorbic, erquhart |
| Keywords | netlify, netlify-cms, backend, github |

## Links

- npm: https://www.npmjs.com/package/netlify-cms-backend-github
- Repository: https://github.com/netlify/netlify-cms.git#master
- Homepage: https://github.com/netlify/netlify-cms/tree/master#readme
- Issues: https://github.com/netlify/netlify-cms/issues
- npm.io page: https://npm.io/package/netlify-cms-backend-github

## Dependencies (9)

- [graphql](https://npm.io/package/graphql.md) ^15.0.0
- [js-base64](https://npm.io/package/js-base64.md) ^3.0.0
- [semaphore](https://npm.io/package/semaphore.md) ^1.1.0
- [common-tags](https://npm.io/package/common-tags.md) ^1.8.0
- [graphql-tag](https://npm.io/package/graphql-tag.md) ^2.10.1
- [apollo-client](https://npm.io/package/apollo-client.md) ^2.6.3
- [apollo-link-http](https://npm.io/package/apollo-link-http.md) ^1.5.15
- [apollo-link-context](https://npm.io/package/apollo-link-context.md) ^1.0.18
- [apollo-cache-inmemory](https://npm.io/package/apollo-cache-inmemory.md) ^1.6.2

## Recent versions

- 2.14.1 (latest) — 2022-04-13
- 2.13.0-beta.0 (beta) — 2021-05-03
- 2.5.0-beta.1 (not-latest) — 2019-08-27
- 2.14.0 — 2021-10-18
- 2.13.5 — 2021-10-15
- 2.13.4 — 2021-07-20
- 2.13.3 — 2021-06-01
- 2.13.2 — 2021-05-31
- 2.13.1 — 2021-05-19
- 2.13.0 — 2021-05-04
- 2.12.0 — 2021-04-04
- 2.11.9 — 2021-02-23
- 2.11.8 — 2021-02-10
- 2.11.7 — 2020-12-06
- 2.11.6 — 2020-09-20
- … 61 more at https://npm.io/package/netlify-cms-backend-github/versions

## README

# GitHub backend

An abstraction layer between the CMS and [Github](https://docs.github.com/en/rest)

## Code structure

`Implementation` for [File Management System API](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-util/README.md) based on `Api`.

`Api` - A wrapper for GitHub REST API.

`GraphQLApi` - `Api` with `ApolloClient`. [Api docs](https://docs.github.com/en/graphql) and [netlify docs](https://www.netlifycms.org/docs/beta-features/#github-graphql-api).

`AuthenticationPage` -  uses [lib-auth](https://github.com/netlify/netlify-cms/tree/master/packages/netlify-cms-lib-auth/README.md) to facilitate OAuth and implicit authentication.

`scripts` -  use `createFragmentTypes.js` to create GitHub GraphQL API fragment types.

Look at tests or types for more info.

---
_Source: https://npm.io/package/netlify-cms-backend-github · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._