https://github.com/sallar/github-contributions-canvas

A tool for drawing a heat-map of Github contributions on HTML Canvas
https://github.com/sallar/github-contributions-canvas

Last synced: about 2 months ago
JSON representation

A tool for drawing a heat-map of Github contributions on HTML Canvas

• Host: GitHub
• URL: https://github.com/sallar/github-contributions-canvas
• Owner: sallar
• License: mit
• Created: 2018-05-02T15:22:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-16T18:43:11.000Z (7 months ago)
• Last Synced: 2024-07-05T00:44:29.358Z (3 months ago)
• Language: TypeScript
• Size: 893 KB
• Stars: 179
• Watchers: 4
• Forks: 42
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Github Contributions on Canvas [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

A tool for drawing a heat-map of Github contributions on HTML Canvas.

This module is used for drawing user contributions in [this project](https://github-contributions.now.sh).

## Install

```sh

$ npm install github-contributions-canvas

```

## Usage

```js

import { drawContributions } from "github-contributions-canvas";

drawContributions(canvasEl, {

  data: contributionData,

  username: "myusername",

  themeName: "standard",

  footerText: "Made by @sallar - github-contributions.now.sh"

});

```

## Available Themes

The themes are defined in the [`src/themes.js`](src/themes.js) file.

Currently the available themes are:

- `standard`

- `halloween`

- `teal`

- `leftPad`

- `dracula`

- `blue`

- `panda`

- `sunny`

- `pink`

- `YlGnBu`

- `solarizedDark`

- `solarizedLight`

## Data Format

This module accepts the output from [sallar/github-contributions-api](https://github.com/sallar/github-contributions-api) API. Check that project for more info.

## License

Sallar Kaboli © [MIT License](LICENSE)

[npm-image]: https://badge.fury.io/js/github-contributions-canvas.svg

[npm-url]: https://npmjs.org/package/github-contributions-canvas

[travis-image]: https://travis-ci.com/sallar/github-contributions-canvas.svg?branch=master

[travis-url]: https://travis-ci.com/sallar/github-contributions-canvas

[daviddm-image]: https://david-dm.org/sallar/github-contributions-canvas.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/sallar/github-contributions-canvas