grunt-local-neo

> Local SAP WebIDE NEO Runtime

Getting Started

This plugin requires Grunt ^1.0.3

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

``shell
npm install grunt-local-neo --save-dev
`

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

`js
grunt.loadNpmTasks('grunt-local-neo');
`

The "localneo" task

$3


In your project's Gruntfile, add configuration named localneo to Grunt configuration with grunt.config().

`js
grunt.config("localneo", {
options: {
// see next chapter
}
});
`

The task will start a static web server and proxy all requests for paths specified in neo-app.json file.
Intended for local testing of SAPUI5 applications.

$3

#### options.port
Type: Number
Default value: 62493

Server port

#### options.open
Type: Boolean
Default value: false

Open index file after server start

#### options.baseDir
Type: String
Default value: '.'

Base directory to work and server files from

#### options.basePath
Type: String
Default value: "./webapp"

Base path to server files from

#### options.index
Type: String
Default value: ""

Default index file name

#### options.sapUi5
Type: String
Default value: ""

SAPUI5 version. If none specified, latest will be used

#### options.secure
Type: Boolean
Default value: false

Use http of https for local server

#### options.component
Type: String
Default value: ''

SAPUI5 Component ID for sandbox

#### options.proxies
Type: Array
Default value: []

Manual proxy configurations. See grunt-connect-proxy-updated for detailed proxy configuration options

#### options.localResources
Type: Array
Default value: []

Manual additional resource to server via server. See grunt-contrib-connect option base for detailed configuration options

###neo-app.json
This file is used by SAP Cloud Platform to configure destinations for an application.
Local runtime also uses this file with the help of the environment variables (see next chapter)
Please configure your destinations and application resources specified in neo-app.json file vie environment variables.
Example part of neo-app.json
`json
{
"path": "/",
"target": {
"type": "destination",
"name": "",
"entryPath": "/"
},
"description": ""
},
{
"path": "/",
"target": {
"type": "application",
"name": ""
}
}
`

$3

Task uses environment variables for destinations and application configuration.
See dotenv plugin for details.

To configure a destination, create .env file in root folder.
Add this line:
`text
DEST__HOST=
`
If your destination requires authentication, add the following lines (only basic is supported):
`text
DEST__USER=
DEST__PASSWORD=
`

If your application uses other application's files or some custom library connect it with
#### Local computer hosted
`text
LIB__PATH=
`

#### Remote hosted
`text
LIB__HOST=
LIB__PATH=
`
If remote host requires authentication, add the following lines (only basic is supported):
`text
LIB__USER=
LIB__PASSWORD=
`

$3

#### Default set up
`js
grunt.config("localneo", {
options: {
component: ""
}
});
`

Will run on https://localhost:62493 and serve from ./webapp' directory

#### Specific port and auto-open
``js
grunt.config("localneo", {
options: {
port: 12345,
open: true,
index: "test.html"
}
});
``

Will run on https://localhost:12345 and open https://localhost:12345/test.html after start

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

1.0.0 - Project created