https://github.com/sallar/top-tweets

A simple Node.js app to retweet top tweets on Twitter
https://github.com/sallar/top-tweets

Last synced: 9 days ago
JSON representation

A simple Node.js app to retweet top tweets on Twitter

• Host: GitHub
• URL: https://github.com/sallar/top-tweets
• Owner: sallar
• Archived: true
• Created: 2015-08-30T19:16:12.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-02T18:23:56.000Z (about 9 years ago)
• Last Synced: 2024-08-02T14:08:56.591Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 172 KB
• Stars: 26
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Twitter Top Tweets [![Build Status](https://travis-ci.org/sallar/top-tweets.svg?branch=master)](https://travis-ci.org/sallar/top-tweets)

===

A simple Node.js/Express/MongoDB app to retweet best tweets written in a specific language.  

This app makes use of `cld` for language detection since Twitter’s language detection is not

trustable and is based on “Best Effort”.  

[Working Example](https://twitter.com/farsi_favorites) (in Persian).  

## Dependencies

* NodeJS 

* MongoDB

* PM2 (from npm)

* Mocha (from npm)

* Twitter Dev Credentials

## Install

### Install dependecies:

```bash

$ sudo npm install -g pm2

$ sudo npm install -g mocha

$ npm install

```

### Modify Config

Modify config file in `source/app/config.js` and add your Twitter credentials. 

### Add Data Files

Add to files to data directory: `strings.json` and `users.json` both based on this structure:

```json

{

    "banned": [

        "someUser",

        "someOtherEvilUser",

        "..."

    ]

}

```

Items in `strings.json` file are only matched in tweet text, but items in `users.json` file are 

matched both in tweet text and user’s screen name. (Dont include `@` in screen names).

### Run

```bash

$ cd source/

$ pm2 start search

```

## Tests

To run tests:

```bash

npm test

```

## License

This software is released under the [MIT License](http://sallar.mit-license.org/).  

    Copyright © 2015 Sallar Kaboli 

    

    Permission is hereby granted, free of charge, to any person obtaining a copy

    of this software and associated documentation files (the “Software”), to deal

    in the Software without restriction, including without limitation the rights

    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

    copies of the Software, and to permit persons to whom the Software is

    furnished to do so, subject to the following conditions:

    

    The above copyright notice and this permission notice shall be included in

    all copies or substantial portions of the Software.

    

    THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

    THE SOFTWARE.