0.2.2 • Published 1 year ago
@contentlab/git-adapter-github v0.2.2
Introduction
Contentlab is a library that generates a fully functional CRUD GraphQL API for structured text data exclusively from files in a Git repository.
This repository holds code that implements access to Git repositories hosted on GitHub.
Usage
Instantiate the adapter with createAdapter() and then call setRepositoryOptions() with GitHubRepositoryOptions on
the instance. These options are as follows:
| Option name | Required | Default value | Description |
|---|---|---|---|
repositoryOwner | True | GitHub repository owner, e.g. contentlab-sh | |
repositoryName | True | GitHub repository name, e.g. git-adapter-github | |
personalAccessToken | True | GitHub personal access token (classic) with at least repo scope | |
pathSchemaFile | False | schema/schema.graphql | Path to schema file in repository |
pathEntryFolder | False | entries/ | Path to folder for content entries |
License
The code in this repository is licensed under the permissive ISC license (see LICENSE).