https://github.com/astrabert/what-a-git-year

Simple Gradio app to showcase your GitHub achievements in the past year
https://github.com/astrabert/what-a-git-year

advent-of-code docker-image github github-scraping gradio new-year python

Last synced: 6 days ago
JSON representation

Simple Gradio app to showcase your GitHub achievements in the past year

• Host: GitHub
• URL: https://github.com/astrabert/what-a-git-year
• Owner: AstraBert
• License: mit
• Created: 2024-12-01T23:18:18.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-02T02:34:33.000Z (about 1 month ago)
• Last Synced: 2024-12-25T20:12:36.982Z (13 days ago)
• Topics: advent-of-code, docker-image, github, github-scraping, gradio, new-year, python
• Language: Python
• Homepage: https://huggingface.co/spaces/as-cle-bert/what-a-git-year
• Size: 3.35 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# What A Git-Year!

![Docker deployment status](https://github.com/AstraBert/what-a-git-year/actions/workflows/docker-publish.yml/badge.svg)

**What A Git-Year!** is a simple Gradio app to showcase your GitHub achievements in the past year. 

You just need to provide your username and a token with repository-level access ([find/create yours here](https://github.com/settings/tokens)) and the magic will be done in less than a minute!

![Demo for What A Git Year!](imgs/what-a-git-year.gif)

## Run it locally

You can install the app from source code and run it locally:

```bash

git clone https://github.com/AstraBert/what-a-git-year.git

cd what-a-git-year/

python3 -m venv gityear

source gityear/bin/activate

python3 -m pip install -r requirements.txt

python3 app.py

```

And the app should be up and running on http://localhost:7860 in no time!

## Run it with Docker

Use the GitHub Container Registry Docker image to run the application:

```bash

docker pull ghcr.io/astrabert/what-a-git-year:main

docker run -p 7860:7860 ghcr.io/astrabert/what-a-git-year:main

```

The app should be available on http://localhost:7860 in less than one minute!

## Use the HuggingFace Demo

Find a [demo on HuggingFace Spaces](https://huggingface.co/spaces/as-cle-bert/what-a-git-year)

## Contributions

Contributions are more than welcome! See [contribution guidelines](./CONTRIBUTING.md) for more information :)

## Funding

If you found this project useful, please consider to [fund it](https://github.com/sponsors/AstraBert) and make it grow: let's support open-source together!😊

## License and rights of usage

This project is provided under [MIT license](./LICENSE): it will always be open-source and free to use.

If you use this project, please cite the author: [Astra Clelia Bertelli](https://astrabert.vercel.app)