Skip to content

Commit

Permalink
Changes has been added for the checklist and removed console.log
Browse files Browse the repository at this point in the history
  • Loading branch information
@y509144
y509144 committed Jan 12, 2023
1 parent 6db127a commit cf614c7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 145 deletions.
149 changes: 9 additions & 140 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Cumulocity Rest Based Grid Widget Plugin [<img width="35" src="https://user-images.githubusercontent.com/67993842/97668428-f360cc80-1aa7-11eb-8801-da578bda4334.png"/>](https://github.com/SoftwareAG/cumulocity-rest-based-grid-widget-plugin/releases/download/1.0.0-beta/rest-based-grid-runtime-widget-1.0.0-beta.zip)
# Rest Based Grid for Cumulocity [<img width="35" src="https://user-images.githubusercontent.com/32765455/211497905-561e9197-18b9-43d5-a023-071d3635f4eb.png"/>](https://github.com/SoftwareAG/cumulocity-rest-based-grid-widget-plugin/releases/download/1.0.0-beta/rest-based-grid-runtime-widget-1.0.0-beta.zip)



This Cumulocity Rest Based Grid Widget Plugin is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. This Plugins help you to display API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc.
This Rest Based Grid Widget is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. This Rest Based Grid Widget help you to display API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc.

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

### Please choose Rest Based Grid release based on Cumulocity/Application builder version:

|APPLICATION BUILDER | CUMULOCITY | CUMULOCITY REST BASED GRID WIDGET PLUGIN |
|--------------------|-------------|-------------------------------------------|
| 2.0.x(coming soon) | >= 1016.x.x | 1.x.x |
|APPLICATION BUILDER | CUMULOCITY | REST BASED GRID WIDGET |
|--------------------|-------------|------------------------|
| 2.x.x(coming soon) | >= 1016.x.x | 1.x.x |


## Prerequisites:
Expand All @@ -32,146 +32,15 @@ This Cumulocity Rest Based Grid Widget Plugin is the Cumulocity module federatio
## Installation


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

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

### Installation of widget through App Builder


**Supported Cumulocity Environments:**


* **App Builder:** Tested with Cumulocity App Builder version 1.3.0.

### Local Development?

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

**External dependencies:**

```
"@angular/material": "^11.1.2"
"ngx-bootstrap": "6.2.0"
```

**Installation Steps For App Builder:**


**Note:** If you are new to App Builder or not yet downloaded/clone app builder code then please follow [App builder documentation(Build Instructions)](https://github.com/SoftwareAG/cumulocity-app-builder) before proceeding further.



1. Open Your existing App Builder project and install external dependencies by executing below command or install it manually.

```
npm i @angular/material@11.1.2 ngx-bootstrap@6.2.0
```
2. Grab the Rest Based Grid widget **[Latest Release Binary]( https://github.com/SoftwareAG/cumulocity-rest-based-grid-widget/releases/download/2.0.1/gp-rest-based-grid-widget-2.0.1.tgz)**.


3. Install the Binary file in app builder.

```
npm i <binary file path>/gp-rest-based-grid-widget-x.x.x.tgz
```

4. Import GpRestBasedGridWidgetModule in custom-widget.module.ts file located at /cumulocity-app-builder/custom-widgets/

```
import {GpRestBasedGridWidgetModule} from 'gp-rest-based-grid-widget';
@NgModule({
imports: [
GpRestBasedGridWidgetModule
]
})
```

9. Congratulation! Installation is now completed. Now you can run app builder locally or build and deploy it into your tenant.

```
//Start App Builder
npm run start
// Build App
npm run build
// Deploy App
npm run deploy
```

## Build Instructions

**Note:** It is only necessary to follow these instructions if you are modifying/extending this widget, otherwise see the [Installation Guide](#Installation).

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


**Instructions**
1. Clone the repository:
```
git clone https://github.com/SoftwareAG/cumulocity-rest-based-grid-widget-plugin.git
```
2. Change directory:
```
cd cumulocity-rest-based-grid-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 plugin in your existing or new dashboard.



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



1. Open you application from App Switcher
Expand Down Expand Up @@ -221,7 +90,7 @@ Congratulations! Rest Based Grid widget Plugin is configured.



**Asset Viewer On Screen Options:**
**Rest Based Grid On Screen Options:**

* **Nested List VIew**: If the API has Nested List and confirgured as part of the table then on click of main grid a nested list can be seen as Expanded Grid.
* **Search**: Smart Search filter. User can search by device/asset name, external id, device id, alert type, etc.
Expand All @@ -233,6 +102,6 @@ Congratulations! Rest Based Grid widget Plugin is configured.

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

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).
11 changes: 6 additions & 5 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "cumulocity-rest-based-grid-widget-plugin",
"version": "1.0.0-beta",
"description": "This is the Cumulocity module federation plugin. Plugins can be developed to display API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc..",
"description": "This Rest Based Grid Widget displays API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc..",
"scripts": {
"start": "c8ycli server --env.beta=true",
"build": "c8ycli build",
Expand All @@ -11,7 +11,7 @@
"postbuild": " gulp bundle"
},
"keywords": [],
"author": "Sheethal J R- Software AG, Global Presales",
"author": "Meer Arfath - Software AG, Global Presales",
"license": "Apache-2.0",
"dependencies": {
"@angular/animations": "14.0.6",
Expand All @@ -31,7 +31,7 @@
"@ngx-translate/core": "14.0.0",
"@c8y/style": "1016.0.40",
"core-js": "^2.5.4",
"ngx-bootstrap": "6.2.0",
"ngx-bootstrap": "9.0.0",
"rxjs": "~6.6.3",
"zone.js": "~0.11.7"
},
Expand All @@ -56,9 +56,10 @@
"c8y": {
"application": {
"name": "Cumulocity Rest Based Grid Widget Plugin",
"description": "This Rest Based Grid Widget displays API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc..",
"contextPath": "rest-based-grid-runtime-widget",
"key": "rest-based-grid-runtime-widget-application-key",
"globalTitle": "Custom widget with Module Federation",
"globalTitle": "This Rest Based Grid Widget displays API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc..",
"tabsHorizontal": true,
"isPackage": true,
"noAppSwitcher": true,
Expand All @@ -69,7 +70,7 @@
"name": "Cumulocity Rest Based Grid Widget Plugin",
"module": "GpRestBasedGridWidgetModule",
"path": "./widget/gp-rest-based-grid-widget.module.ts",
"description": "This Plugins can be developed to display API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc.."
"description": "This Rest Based Grid Widget displays API data in Grid view with configurable columns and headings. This widget also supports Nested lists, search and server side pagination, etc.."
}
],
"remotes": {
Expand Down

0 comments on commit cf614c7

Please sign in to comment.