1.4.0 • Published 3 years ago

git-contributions-api v1.4.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
3 years ago

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 0.10 or higher is required.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

$ npm install git-contributions-api

Features

  • Create a JSON Server
  • Request the data yourself
  • Focus on high performance

Quick Start

The quickest way to get started with git-contributions-api is to use the module in a script and output a username as shown below:

Install the executable:

$ npm install -g git-contributions-api

Make an index.js file and give it the following contents:

const { Server } = require('git-contributions-api');
const http = require('http');
const PORT = process.env.PORT || 3000

http.createServer(Server).listen(PORT);

Test the application:

$ node index.js

Now visit http://localhost:3000/your-github-username/count!

Contributing

Contributing Guide

Authors

The author of git-contributions-api is Joey Malvinni

List of all contributors

License

Apache 2.0

1.4.0

3 years ago

1.0.0

3 years ago