https://github.com/0xvashishth/git-greeter

A GitHub App for automating the github basic workflow.
https://github.com/0xvashishth/git-greeter

github-app mern nodejs probot

Last synced: 17 days ago
JSON representation

A GitHub App for automating the github basic workflow.

• Host: GitHub
• URL: https://github.com/0xvashishth/git-greeter
• Owner: 0xvashishth
• Created: 2023-03-03T16:26:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-03-06T12:51:33.000Z (over 1 year ago)
• Last Synced: 2024-10-17T00:43:34.961Z (about 1 month ago)
• Topics: github-app, mern, nodejs, probot
• Language: JavaScript
• Homepage: https://gitgreeter.co/
• Size: 50.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Git-Greeter

- A GitHub App for automating the github basic workflow.

- App Link: https://github.com/apps/git-greeter

## Inspiration

In Open-source Programs or Open-Source Contributions, by automating out GitHub workflow, we can focus on real collaboration, instead of getting stuck doing boring housekeeping things, like greeting to the users and assigning initial labels and Reacting on some good messages and so on. And As humans, we can’t always be up 24/7. Sometimes it is nice for your contributors if they can receive prompt response and feedback, instead of waiting until you’re back.

Especially when I was the Project Admin at GirlScript Summer of Code, I faced these issues, So I got inspiration from that and started building this.

## What it does

Many things: 

- It can automatically respond to users on some events like opening the issue or opening the pull request.

- Apply labels to the issue.

- Listing Files on commenting the command in the pull request.

- Assigning the issue on commenting the command in the issue or pull.

- Sending message when pull or issue is closed based on the issue or pull state.

- React on some good messages which have some good keywords.

- Much more...

## How I built it

- I used one GitHub REST API Official documentation, and learnt how to make requests in GitHub Webhooks.

- I utilize Probot tool for configuring this app for GitHub.

- Used Replit for hosting all server, client and GitHub app.

## Challenges I ran into

- I faced an issue in retrieving the data from the mongo DB in Probot index.js configuration, but I found a way of doing the same, and that was same as we do in normal NodeJS server.

## Accomplishments that I'm proud of

- This bot is customizable and whatever we want to do edit the messages.

## What I learned

- Learnt about GitHub REST API

- Learnt how to communicate with different apps via APIs.

- Learnt about GitHub Webhook events

- Got to know about awesome webhook event URL provider called `smee.io`

## What's next for git-greeter

- Want to add some more cool functionalities like making cards and commenting on the same in the issues and pull requests. cards mean the contribution done in the current repo by the user.

Stay Tuned 🎉