Team contribution calendar

GitHub-like contribution calendar for the whole team. Supports GitHub and GitLab.

Status and support

• ✔ stable
• ✔ supported
• ✔ ongoing development

You are viewing the README of the development version. Latest version: v0.3.2

Usage

As dependency

yarn add @c-hive/team-contribution-calendar

We recommend using yarn because of compatibility.

Via CDN

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/c-hive/[email protected]/dist/team-contribution-calendar.min.js">
</script>

Examples

Create your CORS proxy server.

As dependency

import TeamContributionCalendar from "@c-hive/team-contribution-calendar";

const container = document.getElementById("container");
const ghUsernames = [{ name: "gaearon" }, { name: "tenderlove", from: "2020-01-20" }, { name: "thisismydesign", from: "2020-01-20", to: "2020-03-20" }];
const glUsernames = [{ name: "gnachman" }, { name: "sytses", from: "2020-01-20" }];

TeamContributionCalendar(container, ghUsernames, glUsernames, "https://your-proxy-server.com/");

Via CDN

<div class="container"></div>
<script>
  const ghUsernames = [{ name: "gaearon" }, { name: "tenderlove", from: "2020-01-20" }, { name: "thisismydesign", from: "2020-01-20", to: "2020-03-20" }];
  const glUsernames = [{ name: "gnachman" }, { name: "sytses", from: "2020-01-20" }, { name: "gomorizsolt", to: "2020-04-03" }];
  TeamContributionCalendar(".container", ghUsernames, glUsernames, "https://your-proxy-server.com/");
</script>

Conventions

This project follows C-Hive guides for code style, way of working and other development concerns.

License

The package is available as open source under the terms of the MIT License.