https://github.com/daveads/raider
Sends a daily summary of Git commits for the year to the provided email address.
https://github.com/daveads/raider
commits commits-counters git git-commit
Last synced: 4 months ago
JSON representation
Sends a daily summary of Git commits for the year to the provided email address.
- Host: GitHub
- URL: https://github.com/daveads/raider
- Owner: daveads
- Created: 2023-01-18T22:45:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T10:46:27.000Z (over 2 years ago)
- Last Synced: 2023-08-27T11:55:44.720Z (over 2 years ago)
- Topics: commits, commits-counters, git, git-commit
- Language: Python
- Homepage:
- Size: 142 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Raider
Raider ranks specific users based on their GitHub commits for the current year and orders them by commit frequency. The system sends the commit statistics for the year, along with daily commit information, either for you or specific users via email.
### Usage
1. Users commit for the current year:
Edit the `brainiacs.txt` file and add your GitHub username.
2. To get daily commits:
Edit the `specific_brainiacs_data.json` file and add your username.
3. To receive emails:
Add your email addresses.
**NOTE:**
To get receive daily commit via Email : add your username to list in the `brainiacs.txt` and `specific_brainiacs_data.json` files.
## For local build or pushing to a server:
- Clone the repository:
```
git clone git@github.com:daveads/raider.git
```
- Edit the environment variables:
```
mv env_var .env
// Edit details in the .env file
```
- Set up environment variables and perform other setup:
```bash
bash run.sh
```
// Once these steps are completed, you should be all set!