muhammed-rahif / gh-notify Goto Github PK

A GitHub notification receiver Telegram Bot.

• 🔗 Quick links
• 📸 Screenshots
• 🧐 About
• 🏁 Getting Started
  • Prerequisites
  • Installing
• 🔧 Running the tests
  • Coding style tests
• ⛏️ Built Using
• ✍️ Authors
• 🎉 Acknowledgments

• Get started
• Telegram bot ( @Beomax_bot )
• GitHub pages

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!

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

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

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

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!

• To check any files need to be formatted

yarn check-format

• To format all required files

yarn code-format

• 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

• @Muhammed-Rahif - Idea & The whole job so far

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

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