YourEyes is a mobile application designed to assist blind and visually impaired individuals in navigating their surroundings. The app livestreams video to a server in real-time using gRPC, where the server processes the video with an object detection model and returns labels, distances, and directions of detected objects.
- Real-time Video Streaming: The mobile app streams video to a server in real-time.
- Feedback: The app provides labels, distances, and directions of detected objects to the user.
- User-Friendly Interface: Designed to be accessible for blind and visually impaired users.
Please follow this structure that helps in maintaining a clean, organized, and scalable project.
- controllers/: Contains controllers for managing request and response cycles.
- models/: Contains data models.
- services/: Contains business logic and services.
- screens/: Contains the different screens of the application.
- widgets/: Contains reusable widgets used across the app.
- repositories/: Contains data access and storage logic.
- providers/: Contains state management logic.
- helpers/: Contains utility functions and helper classes.
- constants/: Contains constant values used throughout the app.
- themes/: Contains app themes and design-related configurations.
- routes/: Contains navigation logic.
- assets/: Contains static files such as images, fonts, and JSON files.
- Set up project structure
- Implement real-time video streaming
- Make the project to support IOS
- Improve UI/UX for better accessibility
- Add support for additional languages
- Implement settings for customization (e.g., voice speed, language)
- Develop user tutorials and help sections
- Write code documentation
- Provide test cases
We welcome contributions! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes and commit them (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Open a pull request.
Please read our Contributing Guidelines before making any contributions
To get a local copy up and running, follow these simple steps:
- Clone the repository:
git clone https://github.com/your-username/YourEyes-App.git
- Navigate to the project directory:
cd YourEyes-App - Install dependencies:
flutter pub get
- Run the app:
flutter run
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
For questions, feedback, or support, please contact us at:
- Email: Link
- GitHub Issues: YourEyes-App Issues