https://github.com/strifel/githubyearcommits
How many contributions do you have this year?
https://github.com/strifel/githubyearcommits
Last synced: 3 months ago
JSON representation
How many contributions do you have this year?
- Host: GitHub
- URL: https://github.com/strifel/githubyearcommits
- Owner: strifel
- License: mit
- Created: 2018-07-26T19:00:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T03:13:29.000Z (over 2 years ago)
- Last Synced: 2025-01-03T04:41:23.839Z (5 months ago)
- Language: Python
- Homepage: https://commits.strifel.de
- Size: 152 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Year Commits / Github Contribution Challenge
## About
Robmroi and I asked ourselves who is more active on github since the beginning of the year.
Because counting was needed when looking onto the github profile I made this to automatically count.
Since then (a year ago) this evolved a bit, and is now in a usable state and could be used for Contribution Overviews/Challenges.
A use case I can think of is at a Hackathon where you want to create (something like) a leaderboard.
This project is still being worked on:
### Todos:
- let the people edit their profile pages
- More types of challenges (not only year/eternity). Enter a specific start/end date.
- Make everything more beautiful (Please help! :))
## Installation
### Heroku Way:
[](https://heroku.com/deploy)
### Docker way:
`docker run --name gyc -p 8000:80 -d strifel/githubyearcommits`
Please change the admin password afterwards. Standard Password is `admin`
### Manual way:
1. clone the repo
2. run `python3 install.py` and enter a (new) password when prompted. (WARING: Do not use any standard password.)
3. Configure your web server (e.g. Apache WGSI, gunicorn) to use `app.py` (Or run `app.py` (not recommended)). ([ApacheWGSI Config](https://github.com/strifel/githubYearCommits/wiki/Apache-WGSI-Configuration))
4. Navigate your web browser to the page `/login`.
5. Enter admin as username and your new password and setup names of github account(/participants) (Important. only public contributions are count unless you show private contributions on your github account page)
6. Go to the main page (remove /admin in the address bar)
7. Go back to `/admin` and play with the settings ([User permissions informations](https://github.com/strifel/githubYearCommits/wiki/Permissions)).
## Update
#### Recommended only on releases!
1. Stop your web server.
2. Pull the repo (`git pull`)
3. Execute database script (`python3 update.py`)
4. Start your web server.
5. Check out new settings/functions.
## Notice
- You can force reload by going to `/force` path(can be disabled)
- Admin can force reload even if disabled
- You can click on count and hover over another to see percentage.
- You can change path to sqlite database by changing `GYC_DATABASE` environmental variable
## License
On 26th Juli 2018 this is on MIT License.
## Special Thanks go out to
- robmroi for the idea, the design and the darkmode
- sallar for giving an api for contributions
- All the people who build a library (I use).
- Stack Overflow Community (of course).