Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 1.48 KB

README.md

File metadata and controls

43 lines (22 loc) · 1.48 KB

GitHub Metadata Extractor and Updater API

This repository contains an API that can be used to extract metadata from a GitHub repository and update the metadata of a GitHub repository. The API is designed to be used in the context of the FAIRsoft Evaluator. The API is used by the Metadata Extractor for FAIRsoft and the Metadata Updater for FAIRsoft applications. The API can be also used using a user access token to perform the same functions.

This API is a Node.js application that uses Express.js as the web framework. The API uses the GitHub API to extract and update metadata of a GitHub repository. The API uses the Octokit library to interact with the GitHub API.

Installation

To install the API, clone the repository and install the dependencies using npm:

npm install

This project have been successfully tested with Node.js v6.20.0.

Usage

To start the API, run the following command:

node src/index.js

API Reference

The API reference is available in the following link.

License

This project is licensed under the MIT License - see the LICENSE file for details.