Skip to content

Jaid/tweeter-server

Repository files navigation

Tweeter Server

License Sponsor tweeter-server
Build status Commits since v3.5.0 Last commit Issues
Latest version on npm Dependents Downloads

Sends tweets.

Installation

tweeter-server on npm

npm install --global tweeter-server@^3.5.0

tweeter-server on Yarn

yarn global add tweeter-server@^3.5.0

@jaid/tweeter-server on GitHub Packages
(if configured properly)

npm install --global @jaid/tweeter-server@^3.5.0

Usage

Create Twitter apps here.

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:

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:

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.

tweeter-server

For usage instructions:

tweeter-server --help

Development

Setting up:

git clone git@github.com:jaid/tweeter-server.git
cd tweeter-server
npm install

Testing:

npm run test:dev

Testing in production environment:

npm run test

License

MIT License
Copyright © 2020, Jaid <jaid.jsx@gmail.com> (https://github.com/jaid)