Skip to content

Latest commit

 

History

History
128 lines (82 loc) · 2.97 KB

README.md

File metadata and controls

128 lines (82 loc) · 2.97 KB
Raw

Resgrid Unit Application

Resgrid Unit is a tablet and desktop optimized application for use in Appratuses, Vehicles in Teams or Squads

<img src=https://github.com/Resgrid/Unit/blob/8616cdd54ce7e8ccba401053be3fa335ea638d76/imgs/UnitMainScreen.png?raw=true alt="logo" width= height= />

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

🌟 About the Project

📷 Screenshots

image
image
image

🎯 Features

  • Tablet and Laptop Optimized
  • Realtime Geolocation
  • Automatic Vehicle Location (AVL)

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file baseApiUrl

resgridApiUrl

channelUrl

channelHubName

realtimeGeolocationHubName

logLevel

what3WordsKey

isDemo

demoToken

osmMapKey

mapTilerKey

googleMapsKey

loggingKey

appKey

🧰 Getting Started

⚙️ Installation

Install Deps

npm ci

Build App

npm run build

Start Local Sim

npm run start

To copy web assets to native projects

npx cap sync

🏃 Run Locally

Clone the project

https://github.com/Resgrid/Unit

Go to project directory

cd Unit

Install dependencies

npm ci

Start the web server

npm run start

🧭 Roadmap

  • Open Source Unit App
  • Native Mapbox Map with Directions
  • Offline Capibilities

❔ FAQ

  • Can I deploy the Unit App to Google Play or the Apple App Store
  • You can but you cannot inclue "Resgrid" in the name of your application in the name of the application or the store listing.
  • What Do I need to Change to Deploy the Unit App to the stores
  • You will need to search for all occurances of "com.resgrid.unit" and replace it with your app id. You will need to replace the icons, logos, splash screen images with your own.

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.