Project Canary

Project Canary is a virus scanning website for links.

• Currently there is a CORS error which doesn't allow normal functionality.
• Reports back to you if a link is malicious
• Actively maintained by developers
• Feel free to make pull requests or Issues
• Uses Cypress as a testing tool.
• The project uses the VirusTotal API for analysis
• This project is initialised with create-react-app with typescript

Preview

Installation

The steps below will allow you to run this website locally

1. Clone the repo
   1. git clone https://github.com/GabrielMarisescu/Project-Canary
   2. cd Project-Canary
2. Get your own VirusTotal API key
   1. Go to the Virus total website
   2. Sign up / Sign in with your account
   3. On home page, click your user avatar and select "API key"
   4. Copy the API Key
3. Add the API Key to your local environmental variable
   1. Create a file called .env in Project-Canary directory
   2. Add this line and replace xxx with your API key REACT_APP_API_KEY=xxx ( no quotations marks are needed)
4. Install dependencies and run the website locally!
   1. npm install
   2. npm start
5. Enjoy and feel free to report any bugs

Contributing

Everyone is welcomed to contribute to our existing code base via pull requests, find an existing issue and help us fix it.

If you wish to work on additional features, we would strongly recommend you to create an issue with the appropriate tags and assign yourself to the issue or comment appropriately on the issue that you are working on it.

1. Fork the repo
2. Follow steps on Installation from step 2

File structure:

• src/components, Reusable components
• src/assets, Resources such as images
• src/interfaces, Typescript Interfaces
• src/utils, Utility functions
• src/pages, Pages (routes)