https://github.com/mahmudnibir/github-dm-extension
⚕️ A extension for Github that will allow user to DM any user in Github
https://github.com/mahmudnibir/github-dm-extension
dm extension github github-dm
Last synced: 7 months ago
JSON representation
⚕️ A extension for Github that will allow user to DM any user in Github
- Host: GitHub
- URL: https://github.com/mahmudnibir/github-dm-extension
- Owner: mahmudnibir
- License: mit
- Created: 2025-04-01T08:52:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T23:40:12.000Z (11 months ago)
- Last Synced: 2025-04-02T00:20:34.966Z (11 months ago)
- Topics: dm, extension, github, github-dm
- Language: JavaScript
- Homepage:
- Size: 1.14 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
███ ███╗ ██╗████ ███╗██╗ ██╗██╗ ██╗███ ███╗
██╔══██╗██║╚══██╔══╝██║ ██║██║ ██║ ██╔══██╗
████ ██╔╝██║ ██║ ████ ███║██║ ██║███ ███╔╝
██╔═══╝ ██║ ██║ ██╔══██║██║
# 📌 GitHub DM System
---
> [!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](#overview)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contribution](#contribution-guidelines)
- [License](#license)
- [Contact](#contact)
- [Support](#support)
## 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:
```bash
git clone https://github.com/mahmudnibir/github-dm-extension.git
```
2. Navigate to the project directory:
```bash
cd github-dm-extension
```
3. Install dependencies (if any):
```bash
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:
```bash
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](LICENSE) file for details.
---
## Contact
*Developed by [Nibir Mahmud](https://github.com/mahmudnibir)*
📧 **Email**: [nibirbbkr@gmail.com](mailto:nibirbbkr@gmail.com)
🐦 **Github**: [@mahmudnibir](https://github.com/mahmudnibir)
---
## Support
> [!TIP]
If you find this project helpful, **please consider giving it a star ⭐ on GitHub!** It helps others discover the project.
---