Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
SheethalJR authored Jan 10, 2023
1 parent 04fe36e commit c9ce109
Showing 1 changed file with 25 additions and 50 deletions.
75 changes: 25 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Cumulocity Tracking Replay Map Widget Plugin [<img width="35" src="https://user-images.githubusercontent.com/67993842/97668428-f360cc80-1aa7-11eb-8801-da578bda4334.png"/>](https://github.com/SoftwareAG/cumulocity-tracking-replay-map-widget-plugin/releases/download/1.0.0-beta/tracking-replay-runtime-widget-1.0.0-beta.zip)
# Cumulocity Tracking Replay Map Widget Plugin [<img width="35" src="https://user-images.githubusercontent.com/32765455/211497905-561e9197-18b9-43d5-a023-071d3635f4eb.png"/>](https://github.com/SoftwareAG/cumulocity-tracking-replay-map-widget-plugin/releases/download/1.0.0-beta/tracking-replay-runtime-widget-1.0.0-beta.zip)

The Cumulocity Tracking Replay widget is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. The Cumulocity Tracking Replay widget help you to displays track lines of the tracking device with replay feature on map.


![tracking replay image](https://user-images.githubusercontent.com/83225057/120200287-ccd36180-c241-11eb-81b2-302d8ef993aa.png)
The Cumulocity Tracking Replay widget is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. The Cumulocity Tracking Replay widget helps you to display track lines of the tracking device with replay feature on map.

### Please note that this plugin is in currently under BETA mode.

Expand All @@ -13,6 +10,8 @@ The Cumulocity Tracking Replay widget is the Cumulocity module federation plugin
|--------------------|------------|------------------------------------|
| 2.x.x(coming soon) | >= 1016.x.x| 1.x.x |

![tracking replay image](https://user-images.githubusercontent.com/83225057/120200287-ccd36180-c241-11eb-81b2-302d8ef993aa.png)

## Features
* **Tracking Events:** Displays the position in map at a particular time.

Expand All @@ -33,53 +32,29 @@ The Cumulocity Tracking Replay widget is the Cumulocity module federation plugin

## Installation

### Runtime Deployment?
### Runtime Widget Deployment?

* This widget support runtime deployment. Download [Runtime Binary](https://github.com/SoftwareAG/cumulocity-tracking-replay-map-widget-plugin/releases/download/1.0.0-beta/tracking-replay-runtime-widget-1.0.0-beta.zip) and install via Administrations(Beta mode) --> Ecosystems --> Applications --> Packages

### Local Development?

**Requirements:**

* Git
* NodeJS (release builds are currently built with `v14.18.0`)
* NPM (Included with NodeJS)

**External dependencies:**

```
"angular-resize-event": "^1.1.1"
"leaflet2": "npm:leaflet@1.7.1"
```

**Instructions**
1. Clone the repository:
```
git clone https://github.com/SoftwareAG/cumulocity-tracking-replay-map-widget-plugin.git
```
2. Change directory:
```
cd cumulocity-tracking-replay-map-widget-plugin
```
3. Install the dependencies:
```
npm install
```
4. (Optional) Local development server:
```
npm start -- --shell cockpit
```
5. Build the app:
```
npm run build
```
6. Deploy the app:
```
npm run deploy
```
## QuickStart

This guide will teach you how to add widget in your existing or new dashboard.

**NOTE:** This guide assumes you have followed the [Installation instructions](#Installation)

1. Open you application from App Switcher

2. Add new dashboard or navigate to existing dashboard

3. Click `Add Widget`

4. Search for `Tracking Replay Map`

5. Select `Target Assets or Devices`

6. Click `Save`

Congratulations! Tracking Replay Map is configured.

## User Guide

Expand All @@ -104,6 +79,6 @@ npm run deploy

------------------------------

These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.
This widget is provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.
_____________________
For more information you can Ask a Question in the [TECH Community Forums](https://tech.forums.softwareag.com/tag/Cumulocity-IoT).

0 comments on commit c9ce109

Please sign in to comment.