Skip to content

Latest commit

 

History

History
102 lines (65 loc) · 9.26 KB

README.md

File metadata and controls

102 lines (65 loc) · 9.26 KB
Raw

HERE SDK Reference Application for Flutter

The reference application for the HERE SDK for Flutter (Navigate Edition) shows how a complex and release-ready project targeting iOS and Android devices may look like. You can use it as a source of inspiration for your own HERE SDK based projects - in parts or as a whole.

Overview

With this blueprint reference application you can see how UX flows can be built for the HERE SDK - covering the main use cases from searching for POIs, planning and picking a route and finally starting the trip to your destination.

  • Learn how the HERE SDK 4.x can be complemented with rich UI for your own application development.
  • Discover how to avoid common pitfalls, master edge cases and benefit from optimized end user flows.
  • All code using the HERE SDK is implemented in pure Dart following well-established clean code standards.
  • On top, the reference application is enriched with tailored graphical assets - adapted for various screen sizes and ready to be used in your own projects.

If you are looking for smaller bits & pieces or just want to get started with the integration of the HERE SDK into a simpler project, you may want to start looking into our example apps selection including a stripped down hello_map_app that accompanies the Developer's Guide for the HERE SDK.

The reference application hosted in this repo focuses on how specific features can be implemented and used within the context of a full blown Flutter application - not only to show the usage of our APIs and the HERE SDK functionality as clear and understandable as possible, but also to show how complex Flutter projects in general can be organized and developed with production quality.

Supported features (so far):

  • Search: Including suggestions, text search and search along a route corridor using the search library of the HERE SDK.
  • Routing: As of now, the reference application supports the following transport modes: car, truck, scooter and pedestrian using the routing library of the HERE SDK.
  • Turn-By-Turn Navigation: Including maneuver instructions with visual feedback and voice guidance using the navigation library of the HERE SDK.
  • Offline Maps: Including UI to download, install and update regions using the maploader library of the HERE SDK. The application can be operated offline when the in-app offline switch is activated. To operate fully offline, turn also the device's connectivity off.

screenshots

Get Started

The reference application for the HERE SDK for Flutter (Navigate Edition) requires the following prerequisites:

On top you need an IDE of your choice. This could be a text editor or IDEs such as Visual Studio Code with the Flutter extension or Android Studio.

Note: If you want to compile, build & run for iOS devices, you also need to have Xcode and CocoaPods installed. If you only target Android devices, Xcode is not required.

Confirm that you meet the overall minimum requirements as listed in the Developer's Guide for the HERE SDK for Flutter (Navigate Edition).

Add the HERE SDK Plugin

Make sure you have cloned this repository and you have downloaded the HERE SDK for Flutter (Navigate Edition), see above.

  1. Unzip the downloaded HERE SDK for Flutter package. This folder contains various files including various documentation assets.
  2. Inside the unzipped package you will find a TAR file that contains the HERE SDK plugin.
  3. Unzip the TAR file and rename the folder to 'here_sdk'. Move it inside the plugins folder.

Build the Reference Application

  1. Set your HERE SDK credentials: The credentials are read from the environment variables which are set using --dart-define.

  • If you want to set up environment variables from the CLI, run the command: flutter run --dart-define=HERESDK_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID> --dart-define=HERESDK_ACCESS_KEY_SECRET=<YOUR_ACCESS_KEY_SECRET>

  • If you want to run from any IDE, you can add credentials to the .json file for your environment. Create a file .env/dev.json as:

    { "HERESDK_ACCESS_KEY_ID": "<YOUR_ACCESS_KEY_ID>", "HERESDK_ACCESS_KEY_SECRET": "<YOUR_ACCESS_KEY_SECRET>" }

    And add additional run args in the IDE: --dart-define-from-file=.env/dev.json

  1. Go to the repository root folder which contains the pubspec.yaml and run the terminal command flutter pub get to fetch the required dependencies.

  2. Open the project in your IDE of choice and execute the Flutter project for your target platform.

How to build Flutter apps for Android and iOS

If you are new to Flutter, here are more detailed steps for you. You may also want to consult the official Flutter site in general and the Flutter SDK documentation in particular first.

  • Build for Android:
    • Build an Android APK by executing flutter build apk --dart-define-from-file=.env/dev.json or use the command flutter run --dart-define-from-file=.env/dev.json to build and run on an attached device.
  • Build for iOS:
    • Run pod install in the ios folder.
    • Then go back to the repository root folder and type flutter build ios --dart-define-from-file=.env/dev.json to build a Runner.app. Type flutter run --dart-define-from-file=.env/dev.json to build and run on an attached device.
    • You can open the /repository root/ios/Runner.xcworkspace project in Xcode and execute and debug from there.
    • Note: You need to have valid development certificates available to sign the app for device deployment.

Note: You can alternatively also pass the credentails during build by: flutter build apk --dart-define=HERESDK_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID> --dart-define=HERESDK_ACCESS_KEY_SECRET=<YOUR_ACCESS_KEY_SECRET>

Contributing

You can contribute to this open source project and improve it for others. There are many ways to contribute to this project, whether you want to create an issue, submit bug reports or improve the documentation - we are happy to see your merge requests. Have a look at our contribution guide and code of conduct. Happy coding!

Questions and Support

We provide the code 'AS IS'. Using the source code does not come with any additional grant of customer support or promise of specific feature development on our part. If you have any questions, please contact us or check the tag here-api on stackoverflow.com.

License

Copyright (C) 2020-2023 HERE Europe B.V.

See the LICENSE file in the root folder of this project for license details.

For other use cases not listed in the license terms, please contact us.

Note

This application and the HERE SDK itself include open source components which require explicit attribution. Please remember to add open source notices in your project. Furthermore, we ask you not to re-sell the icons included in this project.