PhishHalt is a web application designed to help users determine if a given URL is malicious or not. This project is built using JavaScript, HTML, CSS, and React.
- Input a URL to check if it is malicious.
- Fast and efficient analysis.
- Simple and user-friendly UI.
- JavaScript
- React
- HTML5
- CSS3
To run PhishHalt on your local machine, follow the instructions below:
Ensure you have the following installed on your system:
- Node.js (v14 or higher)
- npm (Node Package Manager)
- PhishHalt Model (Email for access)
-
Clone the repository:
git clone https://github.com/your-username/phishHalt.git
-
Navigate to the server directory:
cd server
-
Navigate to the client directory:
cd client
-
Install dependencies:
npm install
-
Install model:
After getting access to the model, add it to ../server
Once the dependencies are installed, you can start client using below command:
npm start
Next start the the development server using
uvicorn model:app --reload
This will start the application on localhost.
By default, server should be available at http://localhost:8000/
.
By default, client should be available at http://localhost:3000/
.
After starting the app, navigate to http://localhost:3000/
in browser to open the application.
If you would like to contribute to PhishHalt, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-name
). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature-name
). - Open a Pull Request.
For any questions or feedback, feel free to reach out:
- Jerush Imanto M: jerushimanto@gmail.com
- GitHub: https://github.com/jerushimanto