https://github.com/fleetbase/navigator-app
GPS and Order Management Mobile App for Drivers built with React Native
https://github.com/fleetbase/navigator-app
Last synced: about 1 year ago
JSON representation
GPS and Order Management Mobile App for Drivers built with React Native
- Host: GitHub
- URL: https://github.com/fleetbase/navigator-app
- Owner: fleetbase
- License: agpl-3.0
- Created: 2021-06-17T09:35:27.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T04:25:37.000Z (about 1 year ago)
- Last Synced: 2025-04-10T00:16:46.119Z (about 1 year ago)
- Language: TypeScript
- Size: 10.6 MB
- Stars: 38
- Watchers: 4
- Forks: 56
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Open source order managemenr, geolocation tracking & navigation app for Fleetbase drivers & agents.
fleetbase.io | @fleetbase_io | Discord
>
## Table of Contents
- [About](#about)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configure Environment](#configure-environment)
- [Running in Simulator](#running-in-simulator)
- [Run the app in iOS Simulator](#run-the-app-in-ios-simulator)
- [Run the app in Android Simulator](#run-the-app-in-android-simulator)
- [Navigation using Mapbox](#navigation-using-mapbox)
- [Documentation](#documentation)
- [Roadmap](#roadmap)
### About
Fleetbase Navigator is an open source navigation and order management app for drivers and agents using Fleetbase. This app is fully customizable and supports QR code scanning, digital signatures, photos, and routing and navigation for agents. Drivers will be able to update activity to orders on the run as they complete job. Navigator app now includes fuel report and issue management and creation. Enable seamless communication with built in chat with operations personnel and customers.
### Prerequisites
- [Yarn](https://yarnpkg.com/) or [NPM](https://nodejs.org/en/)
- [React Native CLI](https://reactnative.dev/docs/environment-setup)
- Xcode 12+
- Android Studio
### Installation
Installation and setup is fairly quick, all you need is your Fleetbase API Key, and a few commands and your app will be up and running in minutes. Follow the directions below to get started.
Run the commands below; first clone the project, use npm or yarn to install the dependencies, then run `npx pod-install` to install the iOS dependencies. Lastly, create a `.env` file to configure the app.
```
git clone git@github.com:fleetbase/navigator-app.git
cd navigator-app
yarn
yarn pod:install
touch .env
```
### Configure Environment
Below is the steps needed to configure the environment. The first part covers collecting your required API keys.
1. Get your API Keys;
2. **If you don't have a Fleetbase account already** proceed to the [Fleetbase Console](https://console.fleetbase.io/) and click "Create an account", complete the registration form and you will be taken to the console.
3. Once you're in the Fleetbase console select the "Developers" button in the top navigation. Next, select API Keys from the menu in the Developers section, and create a new API key. Copy your secret key generated, you'll need it later.
4. Once you have both required API keys open your `.env` file.
In your `.env` file supply your Fleetbase API secret key, and additionally you will need a Google Maps API Key. Lastly, you'll also need to supply your app/bundle identifier, and an `APP_NAME` key.
Your `.env` file should look something like this once you're done.
```
# .env
APP_NAME=Fleetbase Navigator
APP_IDENTIFIER=io.fleetbase.navigator
APP_LINK_PREFIX=navigator://
FLEETBASE_HOST=https://api.fleetbase.io
FLEETBASE_KEY=
```
### Running in Simulator
Once you have completed the installation and environment configuration, you're all set to give your app a test-drive in the simulator so you can play around.
#### Run the App in iOS Simulator
```
yarn ios
```
#### Run the App in Android Simulator
```
yarn android
```
### Documentation
See the [documentation webpage](https://fleetbase.io/docs).
If you would like to make contributions to the Fleetbase Javascript SDK documentation source, here is a [guide](https://github.com/fleetbase/fleetbase-js/blob/master/CONTRIBUTING.md) in doing so.
### Roadmap
- COMING SOON