NarrateMyWay
We are a group of 5th Year Electronics & Software Engineering students at the University of Glasgow, completing a project to create a navigation application. Our app provides audio signage, giving users a better understanding of their surrounding to improve outdoor and indoor navigation.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
With a large array of navigation tools currently available, NarrateMyWay aims to provide the benefits of visual signs to various groups of individuals, such as visually impaired people, tourists who may not speak the native language and pensioners who require extra mobility aids. This will give users more context to their surroundings to aid navigation and will be achieved by connecting the user's device to various Bluetooth beacons that will be placed at significant locations. Despite the technology being developed for the University of Glasgow campus, it will have the ability to be easily expanded to any location. The technologies extensibility will also be combined with the application being free and available across Andriod and iOS devices.
Technologies Used
- The application for this project is being developed using React Native
- To interact with BLE beacons, the react-native-ble-plx library is being used
Getting Started
To get started with installing and running the NarrateMyWay application please refer to our development guide
Usage
User Interface
Description
The application will produce an audio output describing the next point of interest the user is approaching. This will be dynamically represented on the user interface, specifically designed for visually impaired users. The application will allow users to decide if they want more information regarding the current point of interest or to simply hear the original audio description again. As the application is currently being developed, it is important to note that the displayed user interface is being used as a design concept and may be altered throughout development.
For more examples, please refer to the Documentation
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
To contribute to our project we recommend the following steps:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please look at the Development page within our GitHub Pages for more detailed guidance regarding setup and tools which can be used to optimise the development experience.
License
Distributed under the GPL-3.0 License. See LICENSE for more information.
Contacts
This project is being completed by a team of 5th Year Engineering students at the University of Glasgow: