PhishGuard

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. Contact

About The Project

10 day hackathon project. I decided to create a chrome extension that will read webpage text, find email addresses, and use ZeroBounce API to determine its validity. Hopefully this will help people quickly determine what is a real email.

(back to top)

Built With

Front End

• 
• 
• 

Back End

• 

(back to top)

Getting Started

Prerequisites

npm i

• @types/chrome
• @zerobounce/zero-bounce-sdk

Installation

1. Get an API Key at ZeroBounce API -- only 5 free credits
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in public/config.js

   const REACT_APP_API_KEY = "YOUR API KEY";
   

5. Enter npm run build in the terminal
6. Upload the created dist folder in [chrome://extensions/]
   • Make sure Developer Mode is on
   • Click Load Unpacked
   • Select the dist folder from your repo

Roadmap

• Make this nicer looking
• Add Error Alerts
• Get it on the extension store

See the open issues for a full list of proposed features (and known issues).

(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)

Contact

(back to top)