https://github.com/mawrkus/starline
💫 Visualize the timeline of the stars given to any GitHub repository.
https://github.com/mawrkus/starline
Last synced: 6 months ago
JSON representation
💫 Visualize the timeline of the stars given to any GitHub repository.
- Host: GitHub
- URL: https://github.com/mawrkus/starline
- Owner: mawrkus
- License: mit
- Created: 2016-10-28T01:22:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:11:32.000Z (almost 3 years ago)
- Last Synced: 2025-04-17T10:04:33.834Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 870 KB
- Stars: 9
- Watchers: 2
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 💫 Starline [](#contribute)
Visualize the timeline of the stars given to any GitHub repository. I. e. the number of stars given on any given day.
This package uses the [GitHub API](https://developer.github.com/v3/activity/starring/) to collect all the star creation timestamps. The data is visualized thanks to [D3](https://d3js.org/).
## Installation
The package needs **node >= 6** and for now, can be installed via `git clone` only (for now):
```shell
$ git clone https://github.com/mawrkus/starline.git
$ cd starline
$ npm install
```
At this stage you will need to generate a personal access token. This can be easily done by login in to GitHub then `Profile Settings > Personal access token`. Once generated, place it in a `.env` file:
```shell
$ echo GITHUB_ACCESS_TOKEN=[your github access token] > .env
```
Check [GitHub's documentation](https://developer.github.com/v3/) for more information about the API and authentication in general.
## Usage
```shell
$ npm start
```
Open a Web browser, go to `http://localhost:8000`, et voilà !
Is the repository sleepy, trendy, steady or just dead? I hope this tool will help.
## Contribute
1. Fork it: `git clone https://github.com/mawrkus/starline.git`
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
MIT.
## Background
This small project started out of curiosity: why always considering the number of stars of a GitHub project without considering *when* they were given? After playing a while with GitHub's API, I decided to dig in.
Ideas for a future roadmap:
- Contrast the starline with other activities by adding more graphs: release dates, commits, PR, ...
- Playing more with the visualizations/trying other visualizations libraries