Skip to content

Latest commit

 

History

History
159 lines (107 loc) · 5.38 KB

README.md

File metadata and controls

159 lines (107 loc) · 5.38 KB

Contributors Stargazers MIT License


Logo

PhishSentry.AI

An awesome phishing detection tool for your browser!
Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License

About The Project

Product Name Screen Shot

PhishSentry.AI is a browser extension that uses machine learning to detect phishing websites. It is a free and open-source project that aims to protect users from phishing attacks. The extension currently only supports Google Chrome, but we are working on adding support for other browsers.

Here's why:

  • Phishing attacks are becoming more and more common and are a major threat to internet users.
  • Phishing attacks are becoming more sophisticated and harder to detect.
  • PhishSentry.AI uses machine learning to detect phishing websites, making it more effective than traditional methods.

(back to top)

Built With

PhishSentry.AI is built with these following technologies:

  • Javascript
  • HTML

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Currently, the extension is not available on the Chrome Web Store, so you will need to install it manually. Make sure you have the following installed:

  • Google Chrome

Installation

To manually install the extension:

  1. Clone the repo 
     git clone https://github.com/SimonLariz/PhishSentry.AI.git
  2. Open Google Chrome and go to chrome://extensions/
  3. Enable Developer Mode
  4. Click on "Load unpacked" and select the PhishSentry.AI folder
  5. The extension should now be installed and ready to use

(back to top)

Usage

To use the extension, simply click on the PhishSentry.AI icon in your browser. The popup will will have a button to scan the current email for signs of phishing. The extension will then use machine learning to determine if the email is a phishing attempt.

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)