README.md

JARVIS - Voice Assistant

This application is a robust voice assistant designed to run on the local machine, inspired by the JARVIS voice assistant from the Marvel Universe.

Table of Contents

• Features
• Tech-Stack
• Screenshots
• Installation
• Usage

Features

Core Features

1. Provides intelligent responses to user inquiries through a chatbot interface
2. Opens websites seamlessly in the default browser
3. Initiates applications installed on the local machine
4. Plays videos directly from YouTube
5. Sends messages to contacts via WhatsApp or SMS
6. Makes phone calls through WhatsApp or from the mobile device

Advanced Features

1. Utilizes facial authentication for secure access to the application
2. Listens for specific trigger phrases (hot words) to activate the voice assistant

Tech-Stack

1. HTML, CSS and JavaScript for Frontend
2. SQLite for managing databases of contacts, websites, and installed software
3. Python modules:
   1. Hugging Face for the chatbot
   2. OpenCV for facial recognition
   3. SpeechRecognition for speech-to-text capabilities
   4. Pyttsx3 and playsound for text-to-speech synthesis
   5. OS for executing commands on the local machine
   6. Pvporcupine for hot words detection
   7. And many more like Pipes, Eel, PyWhatkit, PyAudio, Pyautogui, multiprocessing, subprocess, etc
4. VSCode for development requirements
5. Webcam and Windows OS for hardware requirements

Screenshots

Installation

Follow these steps to clone and set up the repository locally:

1. Clone the repository:

   git clone https://github.com/SemalJohari/JARVIS-Voice-Assistant.git
   

2. Navigate to the project directory:

   cd JARVIS-Voice-Assistant
   

3. Create and activate a virtual environment:

   python -m venv venv
   venv\Scripts\activate
   

4. Install the required dependencies:

   pip install -r requirements.txt
   

Usage

To run the project locally, start the development server or application using:

python main.py