https://github.com/anonyma/gh-skipped-commit-alarm

Pings you when you skip "commit day" 💪
https://github.com/anonyma/gh-skipped-commit-alarm

codecommit commit contributions github github-api notifier

Last synced: 15 days ago
JSON representation

Pings you when you skip "commit day" 💪

• Host: GitHub
• URL: https://github.com/anonyma/gh-skipped-commit-alarm
• Owner: Anonyma
• Created: 2022-01-16T18:51:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-13T16:49:22.000Z (over 2 years ago)
• Last Synced: 2024-05-21T07:03:34.294Z (6 months ago)
• Topics: codecommit, commit, contributions, github, github-api, notifier
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Github commit-skipper alarm

**Skip leg day, not commit day ᕦ(ò_óˇ)**

_Frequently forget to commit + push your code at the end of the day? Worry not, we have the right tool to help you..._

## Instructions

> Prerequisites: You will need `npm` (or `yarn`) and Node.js installed

1) `git clone` this repo

2) `cd` into it and run `npm install`

3) Fill in the `.env` file

4) Keep it running in the background with `pm2` or `forever` _(you will need to have these installed)_ or by adding it as a systemd service

```bash

pm2 start index.js

```

_(or alternatively, dockerize it and open a PR :) )_

 

---

### Cron syntax

Find an explanation [here](https://www.npmjs.com/package/node-cron)

```bash

0 19 * * *

# ^ run everyday at 19:00

30 14 * * *

# ^ run everyday at 14:30

```

#### ⚙️ `NOTIFY_ON_WEEKEND`

Set it to `true` if you want to receive alerts on Sat/Sun