https://github.com/jefeish/github-companion

The GitHub companion App helps you keep track of Github activities (it talks !)
https://github.com/jefeish/github-companion

app assistant bot notifications

Last synced: 2 months ago
JSON representation

The GitHub companion App helps you keep track of Github activities (it talks !)

• Host: GitHub
• URL: https://github.com/jefeish/github-companion
• Owner: jefeish
• License: mit
• Created: 2021-11-13T20:07:10.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T20:24:41.000Z (8 months ago)
• Last Synced: 2025-02-01T16:27:15.620Z (4 months ago)
• Topics: app, assistant, bot, notifications
• Language: JavaScript
• Homepage:
• Size: 2.47 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


### This is Max, a speech bot!

Max is a GitHub Companion (App) that notifies you on events, verbally. Hopefully making it more fun to keep up with GitHub notifications.







## Quickstart

### Install this App as a regular [GitHub App](https://docs.github.com/en/developers/apps/managing-github-apps/installing-github-apps)

`Max` needs to run on your local system in order to "speak" to you. We recommend that you run it locally in **Dev mode** (`npm run dev`), or **Normal** mode (`npm start`).

## What does it look like?!

![concept](docs/images/concept.png)