LetsUpgrade / FOOTSTEP-APP

An app to help guide blind people in walking.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FOOTSTEP APP

Project ID: 03

Project Mentor: Dhruv Mehta

Co-Mentor: Abdul Basith


✍  PROJECT DESCRIPTION

An app to help guide blind people in walking.An android/ios app that can help people with visual problems to navigate through crowd better. Phone's camera can be used to see if people are coming on a footpath and give voice instructions to user to change their direction. We can also set the field to 360 degree cameras which will help better navigation as tech gets cheaper.


πŸ“‚  RELEVANT TECHNOLOGY

  • AI/ ML
  • Voice Assistant
  • TensorFlow

βœ… CONTRIBUTIONS BEST PRACTICES

For first time Contributors

First time contributors can read CONTRIBUTING.md file for help regarding creating issues and sending pull requests.

Branch Policy

  • development All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development.
  • master This contains main working code. After significant features/bugfixes are accumulated on development, we make an update to the master branch for release.

Therefore it is requested and expected from all of you to make contribution to development branch for now and then before the final release of the app we will make it apply in the master branch.

Code practices

Please help us follow the best practices to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.

  • Single commit per pull request
  • For writing commit messages please read the COMMITSTYLE carefully. Kindly adhere to the guidelines.
  • Follow uniform design practices. The design language must be consistent throughout the app.
  • The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them by themsleves.
  • If the PR is related to any front end change, please attach relevant screenshots in the pull request description by following the pull request template.

Join the development

  • Before you join development, please set up the project on your local machine, run it and go through the application completely.
  • All the issues are based on first come first serve basis.
  • If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

πŸ’»  GETTING STARTED

=> Fork this repository to start contributing.

=> Open your Git Bash command window and in the root directory type the following commands :

    1) git init -initializes the git repository from the GitHub. 
    2) git clone -Clone the repository to your local machine
      (git clone https://github.com/<your-github-username>/LetsUpgrade/FOOTSTEP-APP.git)

About

An app to help guide blind people in walking.


Languages

Language:Java 100.0%