Skip to content
This repository has been archived by the owner on Oct 2, 2024. It is now read-only.

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CaribouJohn committed Jun 9, 2021
1 parent aeae0ec commit 90e36e3
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,30 @@
# gps
# Software AG - Global Presales CLI
## Introduction
Our goal in Software AG - Global Presales is to facilitate the sales process by providing accelerators to aid in the production of demos and sales assets.

The goal of this tool is to remove some of the overhead when starting new cumulocity projects. There are many common tasks and I believe that a lot of them can be automated. By generating the boilerplate we allow the user to jump straight in with creating content.

The longer term goal of this tool is that it is intended to be a common entry point when starting projects involving npm/angular.

## Features

*N.B. We will be adding new features as needed so the list below will expand over time and with requests.*_

* Cumulocity Application Builder - create runtime widget.
* Scaffolds the code in a standard way.
* provides scripts for building runtime widget
* provides scripts allowing incremental build using ```c8ycli server```
* run the tool and build a working widget without any further steps
* *Future : we will allow you to add common features to the generated project such as charts, common services etc...*

## Prerequisites

The tool is intended for the creation of Angular and Node based assets (at the time of writing). Therefore you will need as a minimum to have a version of [node](https://nodejs.org/en/) installed.

For Widget creation it will also be assumed you have angular installed


## Installation

install either locally

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@
"url": "https://github.com/CaribouJohn/gps/issues"
},
"homepage": "https://github.com/CaribouJohn/gps"
}
}

0 comments on commit 90e36e3

Please sign in to comment.