https://github.com/jaid/tweeter-server
Sends tweets.
https://github.com/jaid/tweeter-server
backend cli server tool tweeter tweets twitter twitter-api twitter-app twitter-bot
Last synced: 7 days ago
JSON representation
Sends tweets.
- Host: GitHub
- URL: https://github.com/jaid/tweeter-server
- Owner: Jaid
- License: mit
- Created: 2019-07-06T15:32:57.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-12-11T04:53:17.000Z (over 2 years ago)
- Last Synced: 2025-04-19T19:13:58.700Z (about 1 month ago)
- Topics: backend, cli, server, tool, tweeter, tweets, twitter, twitter-api, twitter-app, twitter-bot
- Language: JavaScript
- Homepage: https://github.com/Jaid/tweeter-server
- Size: 2.88 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license.txt
Awesome Lists containing this project
README
# Tweeter Server
**Sends tweets.**
## Installation
```bash
npm install --global tweeter-server@^3.5.0
```
```bash
yarn global add tweeter-server@^3.5.0
```
(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))
```bash
npm install --global @jaid/tweeter-server@^3.5.0
```
## Usage
Create Twitter apps [here](https://apps.twitter.com).
### Access token from Twitter
This method is recommended.
If the developer account (= the account the Twitter app is created with) and the bot account (= the account that automatically posts tweets) are the same, the login process over `tweeter-server`'s Koa server is not needed. Instead, all keys can be specified in `secrets.yml`:
```yaml
twitterApps:
myApp:
consumerKey: a
consumerSecret: b
accessToken: c
accessTokenSecret: d
```
### Access token from Tweeter Server
This method is no longer supported.
If the developer account and the bot account are different, only specify the Twitter app's credentials in `secrets.yml`:
```yaml
twitterApps:
myApp:
consumerKey: a
consumerSecret: b
```
And then visit `tweeter-server`'s login endpoint in a web browser where the bot account is logged in.
## CLI Usage
After installing package `tweeter-server` globally, you can use its command line interface.
```bash
tweeter-server
```
For usage instructions:
```bash
tweeter-server --help
```
## Development
Setting up:
```bash
git clone [email protected]:jaid/tweeter-server.git
cd tweeter-server
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```
## License
[MIT License](https://raw.githubusercontent.com/jaid/tweeter-server/master/license.txt)
Copyright © 2020, Jaid \ (https://github.com/jaid)