starline v0.3.2

💫 Starline

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 to collect all the star creation timestamps. The data is visualized thanks to D3.

Installation

The package needs node >= 6 and for now, can be installed via git clone only (for now):

$ 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 logging in to GitHub then Profile Settings > Personal access token. Once generated, place it in a .env file:

$ echo GITHUB_ACCESS_TOKEN=[your github access token] > .env

Check GitHub's documentation for more information about the API and authentication in general.

Usage

$ 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