Phishing Guard API

This API keeps record of phishing attack reports against websites and allows users browsing on the web to know which sites are safe and not safe. Safe browsing universe.

🚀 Start

To start this project, first clone the code using git:

git clone https://github.com/efenstakes/phishing-guard-api api

Navigate to the project directory:

cd api

Install dependencies:

yarn install

Create .env in the src/ directory with below keys:

touch src/.env

DB_URL= PORT=

To start the API run:

yarn dev

To build the API run:

yarn build

To deploy the API to AWS Lambda, ensure you install serverless and run:

yarn build && serverless deploy

Alternatively, you can use docker to run the api.

Build the Docker image:

docker build -t api .

Start the Docker container:

docker run -p 8080:8080 api

Note For SQL users

Typegoose can easily be replaced by an SQL ORM like TypeORM and this API will work perfectly with MySQL, Postgres or any other MYSQL database.

Contact

Contact me through. efenstakes101@gmail.com