Skip to content

README.md

Latest commit

 

History

History
26 lines (18 loc) · 1.62 KB

README.md

File metadata and controls

26 lines (18 loc) · 1.62 KB

TweeBotD (Application Server)

(Note: This repo contains the application code for the Node.js server for the TweeBotD website. Check this repository for the machine learning classification server)

This project's aim is to use machine learning to identify twitter bots. It allows users to sign in using their Twitter account and browse their Twitter timeline; showing alerts for tweets made by 'detected' bot accounts.

Installation

We recommend using docker to run the TweeBotD app. Steps to run the project:

  1. Install Docker

  2. Install docker-compose: pip install docker-compose

  3. Clone the project from the github repository: git clone https://github.com/twitterBotDetector/application-server

  4. Store the environment variables needed to run the project in a .env file in the cloned application-server folder. Check the docker-compose.yml to know what variables are required.

    (Note: Make sure you have a Twitter app for the consumer and access tokens. The first 4 secrets need the app's Twitter OAuth tokens. Click here to create a Twitter app, if you don't have one)

  5. Change directory to application-server and run the app: docker-compose up

  6. Open up a browser and go to http://127.0.0.1:8085

License

This project is licensed under the MIT License - see the LICENSE file for details