Skip to content

mahmudnibir/github-dm-extension

Repository files navigation

███ ███╗ ██╗████ ███╗██╗ ██╗██╗ ██╗███ ███╗ ██╔══██╗██║╚══██╔══╝██║ ██║██║ ██║ ██╔══██╗ ████ ██╔╝██║ ██║ ████ ███║██║ ██║███ ███╔╝ ██╔═══╝ ██║ ██║ ██╔══██║██║

📌 GitHub DM System

GitHub status GitHub Repo stars GitHub forks GitHub contributors GitHub issues GitHub last commit GitHub license GitHub Pull Requests GitHub Code Size Platform


Note

This project is not fully ready yet. Feel free to contribute to this project.

Warning

This project is intended for learning and experimentation. Please use it responsibly and ethically.


📚 Table of Contents

Overview

The GitHub DM System is a Chrome extension that adds a message button to GitHub profiles, allowing users to send direct messages via GitHub Issues. This extension enhances user interaction on GitHub by providing a seamless way to communicate.

Features

  • Adds a message button to GitHub profiles.
  • Utilizes GitHub OAuth for authentication.
  • Direct messaging through GitHub Issues.

Installation

  1. Clone the repository:
    git clone https://github.com/mahmudnibir/github-dm-extension.git
  2. Navigate to the project directory:
    cd github-dm-extension
  3. Install dependencies (if any):
    npm install

Usage

  1. Load the extension in Chrome:
    • Go to chrome://extensions/
    • Enable "Developer mode"
    • Click "Load unpacked" and select the project directory.
  2. Click on the extension icon in the toolbar to open the popup.
  3. Authenticate using your GitHub account.

GitHub OAuth Configuration

To use the GitHub OAuth functionality, you need to set up your GitHub application and add the following environment variables in a .env file:

GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret

Running the Server

To run the server for handling OAuth callbacks:

node app.js

The server will be running on http://localhost:8080.

Permissions

The extension requires the following permissions:

  • identity: For OAuth authentication.
  • storage: To store user data.
  • activeTab: To interact with the current tab.
  • scripting: To execute scripts on the page.

Contribution Guidelines

💡 Want to improve the script? Contributions are welcome!

📌 How to Contribute

Step Action
🏗 Fork Clone the repo & create a new branch
🔧 Develop Make your changes, write clear commit messages
📌 Push Push to your fork & create a PR
🚀 Review Wait for approval & merge

License

📝 This project is licensed under the MIT License. See the LICENSE file for details.


Contact

Developed by Nibir Mahmud

📧 Email: nibirbbkr@gmail.com
🐦 Github: @mahmudnibir


Support

Tip

If you find this project helpful, please consider giving it a star ⭐ on GitHub! It helps others discover the project.


About

⚕️ A extension for Github that will allow user to DM any user in Github

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published