gitstat

README

gitstat

This tool generates a JSON logfile of one or more git repositories intended to be used on gitstat.com.

How to use?

1. Download the zip archive from the releases.

2. Extract the binary.

3. Run the following on linux/mac:

   $ cd <EXTRACTED_PATH>
   $ ./gitstat ../project-1 ../project-2
   

   Or on windows:

   $ dir <EXTRACTED_PATH>
   $ .\gitstat.exe ..\project-1 ..\project2
   

4. Upload the generated logfile to gitstat.com.

Todo

See the Kanban board here.

Release

To release setup your MacOS signing certificate for gon do the following:

$ export AC_PASSWORD="<apps-specific-password>>"
$ export GITHUB_TOKEN="<github-repo-token>"
$ git tag -a v0.0.1 -m "First release"
$ git push origin v0.0.1
$ goreleaser release --rm-dist

FAQ

Is the data kept private?

Yes. The gitstat.com website runs within your browser and doesn't store the logfile remotely or even locally. As a result if you refresh the page you'll have to submit the logfile again.

The only data that is stored within your browser are the config settings.

I miss feature X or found a bug

If you found a bug or have a feature suggestion, please open an issue here. Issues/features related to the website should be posted in the gitstat-web repository.

Can I contribute?

Yes! Please open a PR. If you want to do significant work I'd recommend opening an issue first, share some thoughts before you invest a lot of your time.