Skip to content
This repository has been archived by the owner on Mar 31, 2023. It is now read-only.

Muhammed-Rahif/GH-Notify

Repository files navigation

GH-Notify Logo


A GitHub notification receiver Telegram Bot.

📝 Table of Contents

🔗 Quick links

📸 Screenshots

Shot

🧐 About

A github notification sending server, on telegram.

What if you get your github notifications on telegram instantly. Are you looking for something just like this. Then I will definitely help you. Register your github personal access token with us.. So I can remind you when your notifications comes... Let's get started from here! It's completely free!

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them.

  1. Git
  2. Node Js
  3. Yarn Package Manager

Installing

A step by step series of examples that tell you how to get a development env running.

Firstly install the required packages

yarn build

And start the local server

  • Development
    yarn devStart
    
  • Production
     yarn start
    

Go to http://localhost:5000 (By default) to view the output.

Note : The client section (React) files lives in src/client folder!

🔧 Running the tests

Coding style tests

  • To check any files need to be formatted
yarn check-format
  • To format all required files
yarn code-format

⛏️ Built Using

  • MongoDB - Cross-platform document-oriented database program
  • Express - Web framework for Node.js
  • ReactJs - A JavaScript library for building user interfaces
  • NodeJs - Node.js® is a JavaScript runtime

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgments

  • @octokit/rest - GitHub REST API client for JavaScript
  • telegraf - Modern Telegram Bot Framework for Node.js
  • picocss - Minimal CSS Framework for semantic HTML