Skip to content

Commit

Permalink
DN-34: Update to map.apps 4.18.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Michel Bröker committed Jun 13, 2024
1 parent dd8241c commit deced7e
Show file tree
Hide file tree
Showing 36 changed files with 562 additions and 693 deletions.
8 changes: 4 additions & 4 deletions .eslintrc
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"extends": "eslint-config-ct-prodeng",
"plugins": [
"vue"
]
"extends": "eslint-config-ct-prodeng",
"plugins": [
"vue"
]
}
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@
/.vscode/settings.json
/.externalToolBuilders/
/package-lock.json
/gulpfile.overrides.js
3 changes: 3 additions & 0 deletions .stylelintignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# add path patterns to ignore style files
**/external-libs/**
**/styles/dijit/**
3 changes: 3 additions & 0 deletions .stylelintrc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "stylelint-config-ct-prodeng"
}
253 changes: 14 additions & 239 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,247 +1,22 @@
# mapapps-remote-project-blueprint
# mapapps-lineofsight

This project is a blueprint for starting a con terra developer network bundle
The LineOfSight widget is a 3D analysis tool that allows you to perform visibility analysis in a SceneView. Visibility
between a given observer and multiple target points is calculated against the currently displayed content in the view,
including ground, integrated meshes and 3D objects such as buildings or trees.

## Build
## Quick start

![example workflow](https://github.com/conterra/mapapps-remote-project-blueprint/actions/workflows/devnet-bundle-snapshot.yml/badge.svg)
Clone this project and ensure that you have all required dependencies installed correctly (see [Documentation](https://docs.conterra.de/en/mapapps/latest/developersguide/getting-started/set-up-development-environment.html)).

## Requirements
Then run the following commands from the project root directory to start a local development server:

- map.apps 4.12.3
- All resources from `map.apps-VERSION/sdk/m2-repository` need to be copied manually to your local Maven repository (e.g. `%UserProfile%/.m2/repository` for Windows, `~/.m2/repository` for MacOS).
```bash
# install all required node modules
$ mvn initialize

## Usage
# start dev server
$ mvn compile -Denv=dev -Pinclude-mapapps-deps

The project supports a 'remote project' and 'standalone project' mode.

### Use 'remote project' mode

In this mode a running map.apps installation must be available on a different machine or server and the map.apps core JavaScript resources are fetched from there.
This mode is the recommended one.

The URL to the existing map.apps installation can be configured inside the `pom.xml` file of this project:

Replace

```xml
<mapapps.remote.base>.</mapapps.remote.base>
# run unit tests
$ mvn test -P run-js-tests,include-mapapps-deps
```

with

```xml
<mapapps.remote.base>http://yourserver/mapapps</mapapps.remote.base>
```

As an alternative, the URL can be declared in a file called `build.properties` with the content

```properties
mapapps.remote.base=http://yourserver/mapapps
```

The "env-dev" Maven profile must be activated when using a `build.properties` file. To activate this profile append `-P env-dev` or `-Denv=dev` to any Maven execution or declare the profile as activated by default in your Maven `settings.xml` file.

### Use 'stand-alone project' mode

In this mode all JavaScript sources are added to this project during development.
The drawback of this mode is that you cannot test authentication and that the default settings are not read from the remote instance.

To use the 'stand-alone project' mode, activate the Maven profile `include-mapapps-deps`: Append `-P include-mapapps-deps` to any Maven execution command or declare the profile as activated by default in your Maven `settings.xml`.

When developing live-configuration widgets in Chrome, this mode is compelling.

### Start a local HTTP server

Start the integrated Jetty server with:

```sh
mvn clean jetty:run -P watch-all
```

Make sure that the `watch-all` Maven profile is activated.
The profile will start a gulp task that watches for changes in your source code.

The Jetty server is then available at [http://localhost:9090](http://localhost:9090).

### Skip installation of Node.js and NPM during Maven execution

By appending `-Denv=dev -Dlocal.configfile=./build.properties` to any Maven execution the development mode is activated.
This means:

- Node.js and NPM are not installed
- the `watch-all` profile is activated
- the `build.properties` file is loaded

To enforce the installation of Node.js and NPM execute:

```sh
mvn initialize
```

This triggers the installation of Node.js and NPM exclusively.

### Start coding

For detailed documentation on how to develop for map.apps go to the [conterra Developer Network](https://developernetwork.conterra.de/de/documentation/mapapps/development-guide) (registration required).

### Make your code production ready

Execute the following command to ensure that all files are compressed/minified and a `dependencies.json` file is calculated:

```sh
mvn clean install -P compress
```

### Upload your code to a map.apps installation

To upload your apps and bundles after compression to an existing map.apps installation activate the `upload` profile:

```sh
mvn clean install -P compress,upload -Dmapapps.user=xyz -Dmapapps.pw=abc
```

If map.apps is running behind an IIS with Integrated Windows authentication then do not configure `-Dmapapps.user` and `-Dmapapps.pw`.
Instead configure `-Dmapapps.useChunkedRequestEncoding=true` and `-Djdk.http.ntlm.transparentAuth=trustedHosts` (or `-Djdk.http.ntlm.transparentAuth=allHosts`) to ensure the user's Windows credentials are used.

### Running the tests

To execute the unit tests inside the project, run [http://localhost:9090/js/tests/runTests.html](http://localhost:9090/js/tests/runTests.html).

Or use the test lifecycle:

```sh
mvn clean test -P run-js-tests,include-mapapps-deps
```

> If you run the project in 'remote project' mode, you will have to edit the `test-init.js` file located in the `/src/test/webapp/js/tests/` folder.
### The 'sample_camera' bundle

There is a sample bundle in this project called "sample_camera" which demonstrates the following aspects of developing for map.apps 4:

- Interaction with ESRI map
- Use of Binding (e.g. with Accessor)
- Building widgets with Vue.js and Vuetify.js

### The 'theme-custom' bundle

- Sample of minimum fileset needed to create a custom theme.
- Make sure bundle is loaded instead of theme-everlasting in sample app
- When renaming/copying the 'theme-custom' bundle to e.g. `theme-[projectname]` make sure to also make the corresponding changes to the following files:

- `gulpfile.js`
- `theme-name/manifest.json`
- `theme-name/styles/styles.less`

### Build Process

- The gulpfile that describes the build process for map.apps themes can be found in the root directory: `/gulpfile.js`
- The `/package.json` file contains the version numbers for the required dependencies for the gulp build process.

## Updating from older versions

### from 4.12.1 to 4.12.2

See [Changelog](./CHANGELOG.md)

### from 4.12.0 to 4.12.1

See [Changelog](./CHANGELOG.md#4121---10112021)

### from 4.11.1 to 4.12.0

See [Changelog](./CHANGELOG.md#4120---2021-08-31)

### from 4.11.0 to 4.11.1

See [Changelog](./CHANGELOG.md#4111)

### from 4.10.1 to 4.11.0

See [Changelog](./CHANGELOG.md#4110)

### from 4.10.0 to 4.10.1

See [Changelog](./CHANGELOG.md#4100---2020-12-09)

### from 4.9.2 to 4.10.0

See [Changelog](./CHANGELOG.md#4100---2020-12-08)

### from 4.9.1 to 4.9.2

See [Changelog](./CHANGELOG.md#492---2020-10-06)

### from 4.9.0 to 4.9.1

See [Changelog](./CHANGELOG.md#491---2020-09-04)

### from 4.8.4 to 4.9.0

See [Changelog](./CHANGELOG.md#490---2020-08-18)

### from 4.8.3 to 4.8.4

See [Changelog](./CHANGELOG.md#484---2020-05-20)

### from 4.8.2 to 4.8.3

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.8.3`
2. Adjust the versions in `devDependencies` in `./package.json` according to the list below:
* "ct-mapapps-gulp-js": "^0.3.6"

### from 4.8.1 to 4.8.2

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.8.2`
2. Change the requirement `babel-polyfill` to `apprt-polyfill` in the `./pom.xml` and `src/test/webapp/js/tests/test-init.js`.
3. Replace `$apprt.load` and `$apprt.lauchAppFromParam` by `$apprt.startApp` in the `src/test/webapp/index.html`

### from 4.8.0 to 4.8.1

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.8.1`

### from 4.7.2 to 4.8.0

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.8.0`
2. Adjust the `ct.jsregistry.version` property in `./pom.xml` to `1.3.4`
3. Adjust the versions in `devDependencies` in `./package.json` according to the list below:
* "ct-mapapps-gulp-js": "^0.2.5"

### from 4.7.1 to 4.7.2

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.7.2`
2. Adjust the `ct.jsregistry.version` property in `./pom.xml` to `1.3.2`
3. Add the version hint `<version>${ct.jsrt-test.version}</version>` for dependencies `ct-jsrt-test-intern` and `ct-jsrt-test-uitest` in `pom.xml`
4. Update the Gulpfile and remove the dev dependencies from `gulpfile.js`. For details see [commit](https://github.com/conterra/mapapps-4-developers/commit/c974a74a08a70316204d5c09aee22f8d39c70446)

### from 4.7.0 to 4.7.1

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.7.1`
2. Adjust the `ct.jsregistry.version` property in `./pom.xml` to `1.3.1`

### from 4.6.1 to 4.7.0

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.7.0`
2. Adjust the `ct.jsregistry.version` property in `./pom.xml` to `1.3.0`
3. Adjust the versions in `devDependencies` in `./package.json` according to the list below:
* "eslint-config-ct-prodeng": "^1.0.5"
* "vue-template-compiler": "2.6.6"

### from 4.6.0 to 4.6.1

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.6.1`

### from 4.5.0 or below to 4.6.0

1. Adjust the `mapapps.version` property in `./pom.xml` to `4.6.0`
2. Adjust the versions in `devDependencies` in `./package.json` according to the list below:
* "ct-mapapps-gulp-js": "~0.1.3"
* "vue-template-compiler": "2.5.17"
3. Go to `./src/test/webapp/index.html` and replace the `corsEnabledServers: ["@@mapapps.remote.base@@"]` with `trustedServers: ["@@mapapps.remote.base@@"]` inside the apprt request configuration object.

## References

* [Vue.js](https://vuejs.org)
* [Vuetify.js](https://vuetifyjs.com)
* [Gulp](http://gulpjs.com)
4 changes: 2 additions & 2 deletions RELEASE.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
✅ Tested for map.apps 4.12.3 / Linie 4
✅ Tested for map.apps 4.18.1 / Linie 4

#### Release Notes
- SNAPSHOT-Release
- autogenerated SNAPSHOT-Release
4 changes: 2 additions & 2 deletions build.properties
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (C) 2021 con terra GmbH ([email protected])
# Copyright (C) 2023 con terra GmbH ([email protected])
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -15,4 +15,4 @@
#

# URL to the remote map.apps instance
mapapps.remote.base=http://%YOURSERVER%/ct-mapapps-webapp-%VERSION%
# mapapps.remote.base=http://%YOURSERVER%/ct-mapapps-webapp-%VERSION%
Loading

0 comments on commit deced7e

Please sign in to comment.