https://github.com/swve/gitstorykit
Build rich git projects history discovery apps with ease, used by Gitstory
https://github.com/swve/gitstorykit
archive commits first-commit git github gitstory history time-machine web-archive
Last synced: 7 months ago
JSON representation
Build rich git projects history discovery apps with ease, used by Gitstory
- Host: GitHub
- URL: https://github.com/swve/gitstorykit
- Owner: swve
- License: gpl-3.0
- Created: 2021-08-09T19:31:34.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-09T16:26:02.000Z (about 3 years ago)
- Last Synced: 2025-02-23T02:12:40.396Z (8 months ago)
- Topics: archive, commits, first-commit, git, github, gitstory, history, time-machine, web-archive
- Language: TypeScript
- Homepage: https://gitstory.app
- Size: 1.07 MB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
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
```js
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
```js
const firstcommit = await gitstory.getFirstCommit();
```
### Get first commit Date
```js
const firstcommitdate = await gitstory.getFirstCommitDate();
```
### Get a commit's Date
Dates should be in the **ISO 8601 format**
```js
const commit_date = await gitstory.getCommitDate(commit_sha);
```
### Get commit between dates
Dates should be in the **ISO 8601 format**
```js
const commit = await gitstory.getCommitsBetweenDates(startDate, endDate, per_page: number, page: number);
```
### Get commits until date
Dates should be in the **ISO 8601 format**
```js
const commit = await gitstory.getCommitsUntilDate(date, per_page: number, page: number);
```
### Get a repository active years
```js
const active_years = await gitstory.yearsActive();
```
## Contributing
To contribute or understand the code structure,
please see our [contributing.md](/CONTRIBUTING.md).
## Authors
Badr B. ([@swve](https://github.com/swve))