Blind Support Project

Smart glasses that helps blind people in their daily life using machine learning and a mobile app.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Server Installation
   • Mobile App Installation
3. Usage
4. Contributing
5. License

About The Project

Smart glasses that helps blind people in their daily life using machine learning and a mobile app.

Built With

• React Native
• Expo
• Flask

(back to top)

Getting Started

This is how you can run this project on your local machine.

Prerequisites

• An ESP32-CAM with Webserver Installed connected to your local WIFI

• Expo CLI Installed on your machine

  npm install expo-cli@latest -g

(back to top)

How to Install the ML server

You need to install python v3 or a higher version to run this project on your machine.

Clone the repository and cd to the server folder, open your terminal and type the following commands:

• Clone the repo and enter the project directory

  git clone https://github.com/taoufikayoub/BlindSupportApp.git
  cd BlindSupportApp
  cd server

• Create a virtual environment:

  python -m venv venv

• Activate the virtual environment:

  ./venv/Scripts/activate

• Install dependencies:

  pip install -r ./requirements.txt

• Run the project:

  flask run

(back to top)

How to Install the Mobile App

Open a new terminal, and type the following commands:

• Enter mobile project folder

  cd mobile

• Install NPM packages

  expo install

• Enter your routes in config.ts

  export const ESP32_CAM_URI = "ENTER YOUR ESP32-CAM IP ADDRESS"; // You will get it from the ESP32-CAM Serial on loading
  export const SERVER_URI = "ENTER THE FLASK SERVER ADDRESS HERE"; // You will get it from the FLASK server debug messages on Loading too

• Run the app

  expo install

• Install Expo Go on your android or iOS device to run it there

(back to top)

Usage

• Wear the smart glasses

• Use your phone to recognize the people in front of you

• You can add the name of the people to the server to recognize them later

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License.

(back to top)