Skip to content
/ botz Public
forked from botim/botz

Browser extension for the Big Bot Project

License

Notifications You must be signed in to change notification settings

liorn/botz

 
 

Repository files navigation

Botz

Botz is a Chrome/Firefox extension that detects suspicious bot activity.

Hat tip to noam-r & Yuval Adam for leading the entire project.

Thanks to anyone who participated in botim.online Hackathons!

Visit https://botim.online to support the project and to submit bot reports.

Table of Contents

Development

  1. Clone to your computer.

  2. Install dependencies:

    yarn install
  3. Building the extension:

    yarn build
    
    # or if you want to watch for file changes
    yarn watch

Using the extension

Chrome

  1. Access chrome://extensions.
  2. Enable Developer mode.
  3. Load the extension with Load unpacked.
  4. You must reload the extension after each change in the code.

Firefox

  1. Access about:debugging.
  2. Select Enable add-on debugging.
  3. Load the extension with Load Temporary Add-on...
  4. You must reload the extension after each change in the code. Firefox
  • The extension is running automatically when Twitter is accessed in the browser.

Contributing

  • Having a problem with the extension? Please open an Issue.
  • Willing to take your chances with some issue, please post a comment to prevent collision with someone else.

If you would like to contribute some feature/bugfix to the project, complete the following steps:

Prerequisites

  1. Bake something and eat it. 🍞
  2. Install Node.js.
  3. Install Yarn.
  4. If you're using VSCode, please install the extensions: TSLint and Prettier - Code formatter.

Submitting Changes

  1. Create a fork of this repository.
  2. Create a branch (git checkout -b feat/check_bot).
  3. Commit your changes (git commit -am "test: add some tests").
  4. Push to the branch (git push origin feat/check_bot)
  5. Open a Pull Request.

Contributors

Thanks goes to these wonderful people (emoji key):

Noam R
Noam R

💼 🖋 📋 🤔 🛡️ 📢
Yuval Adam
Yuval Adam

💼 🖋 📋 🤔 🛡️ 📢
Eran Cohen
Eran Cohen

💻
TomKizaru
TomKizaru

💻
Eran Shmil
Eran Shmil

🤔 🚇 💻
Akiva
Akiva

🤔 🚇 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Browser extension for the Big Bot Project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 74.4%
  • JavaScript 14.2%
  • CSS 11.4%