https://github.com/yegor256/fief

Command-line tool that collects statistics of your GitHub repositories and renders an HTML summary
https://github.com/yegor256/fief

developer-tools github open-source reporting-tool ruby ruby-gem statistics

Last synced: 8 days ago
JSON representation

Command-line tool that collects statistics of your GitHub repositories and renders an HTML summary

• Host: GitHub
• URL: https://github.com/yegor256/fief
• Owner: yegor256
• License: mit
• Created: 2023-06-03T03:43:33.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-15T12:37:27.000Z (22 days ago)
• Last Synced: 2024-10-18T05:45:54.894Z (20 days ago)
• Topics: developer-tools, github, open-source, reporting-tool, ruby, ruby-gem, statistics
• Language: Ruby
• Homepage: https://rubygems.org/gems/fief
• Size: 270 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        


[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)

[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/fief)](http://www.rultor.com/p/yegor256/fief)

[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)

[![rake](https://github.com/yegor256/fief/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/fief/actions/workflows/rake.yml)

[![PDD status](http://www.0pdd.com/svg?name=yegor256/fief)](http://www.0pdd.com/p?name=yegor256/fief)

[![Gem Version](https://badge.fury.io/rb/fief.svg)](http://badge.fury.io/rb/fief)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/fief/blob/master/LICENSE.txt)

[![Maintainability](https://api.codeclimate.com/v1/badges/396ec0584e0a84adc723/maintainability)](https://codeclimate.com/github/yegor256/fief/maintainability)

![Lines of code](https://img.shields.io/tokei/lines/github/yegor256/fief)

[![Hits-of-Code](https://hitsofcode.com/github/yegor256/fief)](https://hitsofcode.com/view/github/yegor256/fief)

This simple script will help you collect statistics about your

GitHub repositories and generate a simple HTML report. First, install it:

```bash

$ gem install fief

```

Then, run it locally and read its output:

```bash

$ fief --repo yegor256/fief --verbose

```

For example, [here is mine](https://yegor256.github.io/fief/).

## How to contribute

Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

Make sure you build is green before you contribute

your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and

[Bundler](https://bundler.io/) installed. Then:

```

$ bundle update

$ bundle exec rake

```

If it's clean and you don't see any error messages, submit your pull request.