CWRC-Git

• CWRC-Git
  • Overview
  • Demo
  • Installation
  • Use
  • API
    • License

Overview

A module for searching GitHub, and for creating and updating XML documents in GitHub. This is done through the GitHub API via octokit/rest.js. Used by the CWRC-GitServer, whose web API is in turn used by the CWRC-GitWriter.

Demo

The CWRC-GitWriter Sandbox is running an instance of CWRC-GitWriter, which uses the code from CWRC-WriterBase and cwrc-git-dialogs. There is a corresponding server component running CWRC-GitServer and using the NPM package published from this repository. The same code is easily (for someone with modest development experience) installed on any server to run your own instance. If you are looking to put together your own CWRC-Writer, CWRC-GitWriter is a good place to start.

Installation

npm install cwrcgit

Use

A simple example:

const cwrcGit = require('cwrcgit');
cwrcGit.authenticate(gitHubOAuthToken);
const repos = cwrcGit.getDetailsForAuthenticatedUser();

API

View the full API here

Also see CWRC-GitServer which makes full use of this API.

License

GNU GPL V2