Skip to content

heysolomon/besafe

Repository files navigation

Contributors Forks Stars Issues MIT License LinkedIn

Logo

beSAFE

A security service for checking URLs against Google's updated lists of unsafe web resources.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Built With
  3. Getting Started
  4. Usage
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

beSAFE

beSAFE is a security tool that checks URLs against Google's constantly updated lists of unsafe web resources. It helps identify and protect against phishing and deceptive sites.

Built With

Getting Started

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

Prerequisites

  • npm
    npm install npm@latest -g

Installation & Setup

Below are steps to follow in setting up the project.

  1. Start a new project and get a free API Key at https://console.cloud.google.com/
  2. Clone the repo
    git clone https://github.com/your_username/besafe.git
  3. Install NPM packages
    npm install
  4. Create a .env.development.local file in your root directory.
  5. Paste your API Key in .env.development.local
    NEXT_PUBLIC_API_KEY = ENTER YOUR API
  6. Run
    npm run dev

(back to top)

Usage

Here's a preview of how the tool works

(back to top)

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. I would greatly appreciate any contributions you make.

If you have a suggestion to improve this, please fork the repo and create a pull request. You can also 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.txt for more information.

(back to top)

Contact

Twitter - @heysolomon_

Project Link: https://github.com/heysolomon/besafe

(back to top)

Acknowledgments

Here are some resources I found very useful while building this project

(back to top)

About

a tool to check for phising links

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published