GitStoryKit is a little development kit that can be used to develop apps and software that enables git time travel, the library is in early development and is designed for simplicity, it is heavily used in GitStory

The following Git clients are supported :

• GitHub ✅
• GitLab ⏳ (on development)

Usage

Initialization

import GitStory from "gitstorykit";

const gitstory = new GitStory("Github");

gitstory.init({ owner: "swve", repo: "framestack" }); 

// with auth tokens
gitstory.init({ owner: "swve", repo: "framestack" , auth: "yourtoken" }); 

Get first commit

const firstcommit = await gitstory.getFirstCommit();

Get first commit Date

const firstcommitdate = await gitstory.getFirstCommitDate();

Get a commit's Date

Dates should be in the ISO 8601 format

const commit_date = await gitstory.getCommitDate(commit_sha);

Get commit between dates

Dates should be in the ISO 8601 format

const commit = await gitstory.getCommitsBetweenDates(startDate, endDate, per_page: number, page: number);

Get commits until date

Dates should be in the ISO 8601 format

const commit = await gitstory.getCommitsUntilDate(date, per_page: number, page: number);

Get a repository active years

const active_years = await gitstory.yearsActive();

Contributing

To contribute or understand the code structure, please see our contributing.md.

Authors

Badr B. (@swve)