@christianesk/github-calendar

Github's Contribution Calendar (NPM)
by StkngEsk

This project returns a calendar of contributions de Github in a <div>...</div> format depending on the user and year chosen.

Content

• Installation
• Implementation

Installation

npm i @christianesk/github-calendar

TS Example

import { getGithubCalendar } from "@christianesk/github-calendar";

const getCalendar = async () => {
   
    return await getGithubCalendar("christianesk", "2020");
} 

/*Returns an Object with these parameters:
    //Example
    { 
        textContributions: "256 contributions in 2020"      
        calendar: "<div>...</div>",
    }
*/

JS Example

const getGithubCalendar = require("@christianesk/github-calendar");

const getCalendar = async () => {
   
    return await getGithubCalendar("christianesk", "2020");
} 

/*Returns an Object with these parameters:
    //Example
    { 
        textContributions: "256 contributions in 2020"      
        calendar: "<div>...</div>",
    }
*/

Implementation examples

Using cloudflare workers

Fetch cloudflare workers with Angular

Styles CSS to github calendar

Using Framework Astro

Authors

• Christian - christianesk
• Jean - jeanstkng

License

MIT © Stkngesk