Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 2.56 KB

File metadata and controls

39 lines (32 loc) · 2.56 KB

Review Assignment Due Date

Breeze Navigation Project

Screenshot 2024-05-06 at 8 14 11 AM Screenshot 2024-05-06 at 8 14 04 AM Screenshot 2024-05-06 at 8 14 00 AM

Introduction

Breeze navigation is a real-time safety app which alerts solo travellers on hazards along their travel route based on tailored news crowdsourcing and user reports. This README file will be touching on the features, navigation setup, and packages used to build this tool.

The application's features include turn-by-turn navigation, hourly weather requests that notify users of upcoming discrepancies on their travel route, a landing page that accepts user's destination as latitude and longitude, and installation of appropriate notification packages for seamless notification integration after publication.

Features

  • Live weather update and automatic notification/warning
  • Turn-by-turn navigation

Setup/installation guide

  1. Look https://docs.mapbox.com/ios/navigation/guides/get-started/install/ to get mapbox api token and other installation guides
  2. Pull this repository, open it as a project in xcode.
  3. Under file, click "Add Package Dependency," and enter https://github.com/mapbox/mapbox-navigation-ios.git

Setting up config file for weather api

  1. Create a .gitignore file in your root directory. Add Navigation/config.json
  2. Create config.json inside Navigation folder
    {
     "apiKey": "your_api_key"
    }
    

Running locally

  1. In your Info.plist file you will need to ensure that you have a private MBXAccessToken so that you are able to access the mapbox libraries
  2. Make sure that you are using iOS 17.4 or the most recent iOS version to access the simulator.
  3. Build your code to view and interact with the simulator.

Packages / Resources

  1. Live weather data: https://openweathermap.org/current
  2. MapBox: https://www.mapbox.com
  3. Mapbox Packages: https://github.com/mapbox/mapbox-navigation-ios.git
  4. Reteno Notifications: https://docs.reteno.com/reference/ios