a11yisimportant

    1.0.0 • Public • Published

    🐦 @a11yisimportant

    Travis CI Coverage Status GitHub Vulnerabilities Twitter Follow

    @a11yisimportant is a Twitter bot which follows smart people tweeting about #a11y and retweets mentions. Written in Typescript and hosted on Oswald Labs Platform.

    ⭐ How it works

    /follow

    The follow endpoint follows users tweeting with the hashtag #a11y. It runs every hour, powered by IFTTT and a webhook:

    1. Find (mixed) tweets with hashtag #a11y
    2. Like all those tweets
    3. Make a list of users (unique)
    4. Remove any users @a11yisimportant already follows
    5. Follow everyone from this list

    /retweet

    The retweet endpoint retweets tweets that @a11yisimportant is tagged in. It runs every hour, powered by IFTTT and a webhook:

    1. Find (recent) tweets with mention @a11yisimportant
    2. Remove any tweets written by self
    3. Remove any tweets which are already retweeted
    4. Like every tweet in this list
    5. If this tweet is a reply, get the original tweet instead
    6. Remove any duplicates (unique array)
    7. Remove any "Thanks for the follow!" tweets
    8. Retweet every tweet in this list

    Interfaces

    This package also exposes the following Typescript interfaces:

    • SearchResult for the result from a standard search using the Twitter API
    • SearchMeta for the metadata in a search result
    • User for a user's profile
    • Tweet for a tweet object

    You can use them like this:

    import { Tweet } from "a11yisimportant/interfaces" 
    const tweet: Tweet = {
      id_str: "1106516296085188609",
      text: "Accessibility is important",
      user: {
        id_str: "1106514269758214144",
        screen_name: "a11yisimportant"
      }
      // . . .
    };

    In each interface, longint strings are preferred since JavaScript natively doesn't support such large integers (e.g., id_str instead of id).

    🛠️ Development

    Install dependencies:

    yarn

    Compile Typescript to CommonJS before running the server:

    yarn build

    Run local server:

    yarn start

    ✅ Todo

    • Auto follow
    • Auto retweet
    • Retweet CC original tweets
    • Like all mentions
    • Like all #a11y tweets

    📝 License

    MIT

    Keywords

    none

    Install

    npm i a11yisimportant

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    16.9 kB

    Total Files

    13

    Last publish

    Collaborators

    • anandchowdhary