Skip to content

Dewiin/blind-spot

Repository files navigation

logo

AI-Powered World Description App


Table of Contents
  1. Introduction
  2. Features
  3. Getting Started
  4. Demo
  5. Contributing
  6. License

Introduction

The AI World Description App is designed to provide users with real-time descriptions of their surroundings through a live camera feed. This app leverages cutting-edge AI technologies to enhance accessibility and understanding of the environment.

Model Workflow

flowchart

Back to top

Features

  • Speech-Activated Image Capture: Users can activate the app with a simple voice command to take a snapshot of the live camera feed.

  • AI-Powered Image Description: The app uses an AI agent to analyze the captured image and generate a description of the scene.

  • Text-to-Speech Output: The generated description is converted into speech, allowing users to hear the information audibly.

Built With

HTML CSS Javascript React Vite Python Google Gemini Flask

Back to top

Getting Started

To get a local copy of Blind Spot up and running locally follow these steps:

Prerequisites

  1. Make sure you have Python installed and use Python3 version 3.12
    NOTE: You can check if Python is installed and its version with
    python -V | python --version
  2. Make sure you have Git installed
    NOTE: You can check if Git is installed and its version with
    git -v | git --version

Setup

  1. Navigate to the directory where you want to clone/run/save the application:
    cd example_directory
  2. Clone the repository:
    git clone https://github.com/Dewiin/blind-spot.git
  3. Navigate to the project directory:
    cd blind-spot
  4. First, download the dependencies in package.json:
    npm install
  5. Next, create a Python virtual environment in the cloned project directory:
    python3.12 -m venv .venv
  6. Activate the virtual environment (Windows OR Mac/Linux):
    1. Windows
        .\.venv\Scripts\activate
    2. Mac/Linux
        source .venv/bin/activate
  7. Install the python dependencies:
    pip install -r requirements.txt
  8. Set up a Gemini API key:
    • Inside the root directory, create a .env file. Inside the .env file, write:
      GOOGLE_API_KEY = "your-api-key"
    • Replace your-api-key with your Gemini API key (keep the quotations).

Usage

  1. Run the application:
    # activate backend server
    python src/backend/server.py
    # run application
    npm run dev
  2. Voice Commands:
    • "Describe the scene."
    • "What's happening."
    • "Guide me."
    • "Show me my blind spot."

Back to top

Demo

demo video

Back to top

Contributing

We like open-source and want to develop practical applications for real-world problems. However, individual strength is limited. So, any kinds of contribution is welcome, such as:

  • New features
  • New models (your fine-tuned models)
  • Bug fixes
  • Typo fixes
  • Suggestions
  • Maintenance
  • Documents
  • etc.

Heres how you can contribute:

  1. Fork the repository
  2. Create a new feature branch
  3. Commit your changes
  4. Push to the branch
  5. Submit a pull request

Back to top

License

MIT License

Copyright (c) 2025 Devin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.