Skip to content

abhiyanpa/Cruze-Scan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

14 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

image

CRUZE SCAN πŸ›‘οΈ

Advanced online virus scanner and malware detection tool powered by Firebase and VirusTotal API. Analyze suspicious files, domains, IPs and URLs to detect security threats with CORS-free architecture.

✨ Features

  • πŸ“ File Scanning - Upload files up to 32MB with drag & drop support
  • πŸ”— URL Scanning - Analyze suspicious URLs in real-time
  • πŸ” Smart Search - Lookup domains, IPs, and file hashes
  • πŸ”„ Real-time Analysis - Live threat detection and progress tracking
  • πŸ“Š Detailed Reports - Comprehensive security analysis from multiple engines
  • πŸš€ Firebase Powered - Analytics and ready for authentication
  • 🌐 CORS Solution - Seamless API integration with CORS proxy

πŸ› οΈ Tech Stack

  • Frontend: React 18 + TypeScript
  • Styling: Tailwind CSS
  • Build Tool: Vite
  • Backend: Firebase (Analytics, Auth, Firestore, Storage)
  • API: VirusTotal API v3
  • Routing: React Router v6 (v7 ready)
  • CORS Proxy: Custom Cloudflare Worker

πŸš€ Getting Started

Prerequisites

  • Node.js 16+ and npm
  • VirusTotal API key (Get one here)
  • Firebase CLI (optional, for deployment)

Quick Setup

  1. Clone the repository:
git clone https://github.com/abhiyanpa/cruzescan.git
cd cruzescan
  1. Install dependencies:
npm install
  1. Add your VirusTotal API key:

    • Open src/utils/api.ts
    • Replace const VIRUSTOTAL_API_KEY = ''; with your actual API key
  2. Start development server:

npm run dev
  1. Open your browser:
    • Navigate to http://localhost:5173

πŸ“– Documentation

🎯 Available Scripts

npm run dev              # Start development server
npm run build            # Build for production
npm run preview          # Preview production build
npm run lint             # Lint code
npm run deploy           # Build and deploy to Firebase
npm run deploy:hosting   # Deploy only hosting to Firebase

🌐 CORS Solution

This application uses a custom CORS proxy to bypass browser restrictions:

Browser β†’ CORS Proxy β†’ VirusTotal API βœ…

The proxy is hosted at: https://cors-proxy.errcruze404.workers.dev/

πŸ”₯ Firebase Integration

The application is fully integrated with Firebase services:

  • βœ… Hosting - Static site hosting
  • βœ… Analytics - User analytics and tracking
  • ⏳ Authentication - Ready for user authentication
  • ⏳ Firestore - Ready for database features
  • ⏳ Storage - Ready for file storage

πŸ“ Project Structure

cruze-scan/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ firebase.ts          # Firebase configuration
β”‚   β”œβ”€β”€ utils/
β”‚   β”‚   └── api.ts           # API utilities with CORS proxy
β”‚   β”œβ”€β”€ pages/
β”‚   β”‚   β”œβ”€β”€ Terms.tsx        # Terms of Service
β”‚   β”‚   └── Privacy.tsx      # Privacy Policy
β”‚   β”œβ”€β”€ App.tsx              # Main application
β”‚   β”œβ”€β”€ main.tsx             # Entry point
β”‚   └── index.css            # Global styles
β”œβ”€β”€ firebase.json            # Firebase configuration
β”œβ”€β”€ .firebaserc              # Firebase project settings
└── package.json             # Dependencies

πŸ” Environment Variables

Create a .env file (see .env.example):

VITE_VIRUSTOTAL_API_KEY=your-api-key-here
VITE_CORS_PROXY=https://cors-proxy.errcruze404.workers.dev/?url=

🚒 Deployment

Firebase Hosting

# First time
npm install -g firebase-tools
firebase login

# Deploy
npm run deploy

Other Platforms

The app is a standard React SPA and can be deployed to:

  • Vercel
  • Netlify
  • GitHub Pages
  • Any static hosting service

Just run npm run build and deploy the dist folder.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  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

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘¨β€πŸ’» Author

Abhiyan P A

πŸ™ Acknowledgments

  • VirusTotal - For the amazing threat intelligence API
  • Firebase - For hosting and analytics
  • React - For the awesome UI library
  • Tailwind CSS - For the utility-first CSS framework

πŸ“Š Status

Build Status Firebase CORS React Router


⭐ Star this repository if you find it helpful!

Created by Abhiyan P A

About

Advanced online virus scanner and malware detection tool. Analyze suspicious files, domains, IPs and URLs to detect security threats.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Contributors