1
Fork 0
mirror of https://github.com/RGBCube/TwitterDiscordWebhook synced 2025-07-27 04:57:44 +00:00
TwitterDiscordWebhook/README.md
2023-03-18 12:20:16 +03:00

58 lines
2.4 KiB
Markdown

# Twitter -> Discord Webhook
Simple (enough) to configure Twitter -> Discord webhook. Runs on Node.js
## Setup
### Clone This Project & Cd Into It
> You will need `git` installed to do this!
```sh
git clone https://github.com/RGBCube/TwitterDiscordWebhook
cd TwitterDiscordWebhook
```
### Configure
Edit the `config.example.json` and rename it to `config.json` with the given information below:
* `discord.webhookUrl`: The Discord webhook url, for more information check out [this](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) page.
* `discord.webhookName`: The username of your Discord webhook.
* `discord.webhookAvatar`: The avatar of your Discord webhook.
* `discord.webhookMessage`: The message before your Twitter link. Formatted as `{message} {tweetLink}`, no newline added.
* `twitter.apiKey`: The Twitter API key, if you do not have a Twitter developer account then check out [this](https://developer.twitter.com/en) page.
* `twitter.apiSecret`: The Twitter API secret, requires a Twitter developer account.
* `twitter.accessToken`: The Twitter account access token, requires a Twitter developer account.
* `twitter.accessSecret`: The Twitter account acesss secret, requires a Twitter developer account.
* `followingUserId`: The user ID for the Twitter account you want notifications from, to find a Twitter ID use [this](https://tweeterid.com/) tool.
### Install Dependencies
> You will need Node.js installed to do this and the next section! If you don't have it installed, you can install it from [here](https://nodejs.org/en/).
```sh
npm install
```
### Run
```sh
node main.js
```
## License
```
TwitterDiscordWebhook
Copyright (C) 2022-present Stovven & RGBCube
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```