Skip to content

Commit 220265f

Browse files
committed
Replace references to demo-app with stock app
1 parent f99148b commit 220265f

File tree

7 files changed

+43
-36
lines changed

7 files changed

+43
-36
lines changed

src/QuickStart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ If you don't need the advanced functionalities provided by `qwc-services` or wan
6363

6464
To work with QWC2, you will need a minimal development environment consisting of [git](https://git-scm.com/), [node](https://nodejs.org/) and [yarn](https://yarnpkg.com). You will also need a running QGIS Server instance which serves your projects.
6565

66-
The fastest way to get started is by cloning the demo application:
66+
The fastest way to get started is by cloning the stock application:
6767
```bash
68-
git clone --recursive https://github.com/qgis/qwc2-demo-app.git
68+
git clone https://github.com/qgis/qwc2.git
6969
```
7070
Next, install all required dependencies:
7171
```bash
72-
cd qwc2-demo-app
72+
cd qwc2
7373
yarn install
7474
```
7575
Then, start a local development application:

src/configuration/ThemesConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ To use a custom thumbnail for an automatically configured theme, place a an imag
7575

7676
The theme configuration file is located as follows:
7777

78-
- Standalone viewer: `qwc2-app/themesConfig.json`
78+
- Standalone viewer: `qwc2-app/static/themesConfig.json`
7979
- `qwc-docker`: `qwc-docker/volumes/config-in/<tentant>/themesConfig.json`
8080

8181
*Note*: when using `qwc-docker`, the themes configuration may also be embedded as `themesConfig` directly in `qwc-docker/volumes/config-in/<tentant>/tenantConfig.json`.
@@ -126,7 +126,7 @@ The `themesConfig.json` file contains a list of themes, optionally organized in
126126

127127
Refer to [External layers](#external-layers), [Theme info links](#theme-info-links), [Plugin data](#plugin-data) and [Background layers](#background-layers) for the format of the respective definitions.
128128

129-
Refer to the [sample `themesConfig.json`](https://github.com/qgis/qwc2-demo-app/blob/master/themesConfig.json) for a complete example.
129+
Refer to the [sample `themesConfig.json`](https://github.com/qwc-services/qwc-docker/blob/master/volumes/config-in/default/themesConfig.json) for a complete example.
130130

131131
The format of the theme definitions is as follows:
132132
<!-- Important: Use U+00A0 non-breaking spaces ( ) in code blocks -->

src/configuration/ViewerConfiguration.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ First of all, it is important to keep in mind that the QWC2 Viewer is designed t
88
- [Customizing the assets](#viewer-asset): specify additional search providers, customize the color schemes, etc...
99
- [Compiling a custom viewer](#custom-viewer): configure which components which are built into the application, add own plugins, etc...
1010

11-
The `qwc2-demo-app` (and the `qwc-map-viewer-demo` docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application.
11+
The `qwc2` stock application (and the `qwc-map-viewer` docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application.
1212

1313
## Load-time configuration `config.json`<a name="load-time-config"></a>
1414

@@ -17,7 +17,7 @@ The load-time configuration `config.json` configuration file contains global vie
1717
- `qwc-docker`: `qwc-docker/volumes/config-in/<tentant>/config.json`
1818
- Standalone viewer: `qwc2-app/static/config.json`
1919

20-
Refer to the [sample `config.json`](https://github.com/qgis/qwc2-demo-app/blob/master/static/config.json) for a concrete example.
20+
Refer to the [sample `config.json`](https://github.com/qgis/qwc2/blob/master/static/config.json) for a concrete example.
2121

2222
### Global settings
2323

@@ -245,11 +245,11 @@ Furthermore, the application entry point `index.html` is located as follows:
245245
This file noteably specifies the application title, and references many of the assets located below the `assets` folder.
246246

247247
### Customizing the color scheme
248-
The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see [DefaultColorScheme.css](https://github.com/qgis/qwc2/blob/master/components/style/DefaultColorScheme.css)). To define a custom color scheme, copy the default color scheme to `assets/css/colorschemes.css`, add an appropriate class name to the `:root` selector, and modify the colors as desided. Two additional examples (`highcontrast` and `dark`) are provided by default in[`assets/css/colorschemes.css`](https://github.com/qgis/qwc2-demo-app/blob/master/static/assets/css/colorschemes.css).
248+
The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see [DefaultColorScheme.css](https://github.com/qgis/qwc2/blob/master/components/style/DefaultColorScheme.css)). To define a custom color scheme, copy the default color scheme to `assets/css/colorschemes.css`, add an appropriate class name to the `:root` selector, and modify the colors as desided. Two additional examples (`highcontrast` and `dark`) are provided by default in[`assets/css/colorschemes.css`](https://github.com/qgis/qwc2/blob/master/static/assets/css/colorschemes.css).
249249

250250
You can then modify the color scheme which is applied by default by setting `defaultColorScheme` in `config.json` to an appropriate class name (i.e. `highcontrast` or `dark`).
251251

252-
To change the color scheme at runtime in QWC2, make sure the `Settings` plugin is enabled, and in the `Settings` plugin configuration block in `config.json` list the color schemes below `colorSchemes`. Refer to the [sample `config.json`](https://github.com/qgis/qwc2-demo-app/blob/master/static/config.json).
252+
To change the color scheme at runtime in QWC2, make sure the `Settings` plugin is enabled, and in the `Settings` plugin configuration block in `config.json` list the color schemes below `colorSchemes`. Refer to the [sample `config.json`](https://github.com/qgis/qwc2/blob/master/static/config.json).
253253

254254
*Note*: When changing the color scheme via Settings dialog in QWC2, the picked color scheme is stored in the browser local storage, and this setting will override the `defaultColorScheme` setting from `config.json`. Specifying the `style` URL-parameter (see [URL parameters](../topics/Interfacing.md#url-parameters)) will take precedence over all other settings.
255255

@@ -288,10 +288,7 @@ The legend print template `assets/templates/legendprint.html` is used when print
288288

289289
## Building a custom viewer <a name="custom-viewer"></a>
290290

291-
QWC2 is divided into two repositories:
292-
293-
- The QWC2 components, hosted at [https://github.com/qgis/qwc2/](https://github.com/qgis/qwc2/). This repository contains the core building blocks common to all QWC2 applications.
294-
- The QWC2 application, the demo application is hosted at [https://github.com/qgis/qwc2-demo-app](https://github.com/qgis/qwc2-demo-app).
291+
The QWC2 stock application, hosted at [https://github.com/qgis/qwc2/](https://github.com/qgis/qwc2/), can serve as a base for building a custom application. An example of a custom application is hosted at [https://github.com/qgis/qwc2-demo-app](https://github.com/qgis/qwc2-demo-app).
295292

296293
To build a custom viewer, the first step is cloning the demo application:
297294
```bash
@@ -300,23 +297,23 @@ git clone --recursive https://github.com/qgis/qwc2-demo-app.git qwc2-app
300297
The typical layout of a QWC2 app source tree is as follows:
301298

302299
| Path | Description
303-
|------------------------------|---------------------------------------------------------------------|
304-
|`├─ static/` | |
305-
|`│ ├─ assets/` | See [Viewer assets](#viewer-assets) |
306-
|`│ ├─ translations/` | Translation files. |
307-
|`│ ├─ config.json` | Master configuration file. |
308-
|`│ └─ themes.json` | Full theme configuration, autogenerated from `themesConfig.json`. |
309-
|`├─ js/` | |
310-
|`│ ├─ app.jsx` | Entry point of the ReactJS application. |
311-
|`│ ├─ appConfig.js` | Configuration of the qwc2 core modules. |
300+
|------------------------------|-----------------------------------------------------------------------|
301+
|`├─ static/` | |
302+
|`│ ├─ assets/` | See [Viewer assets](#viewer-assets) |
303+
|`│ ├─ translations/` | Translation files. |
304+
|`│ ├─ config.json` | Master configuration file. |
305+
|` ├─ themesConfig.json` | Themes configuration, edited manually. |
306+
|`│ └─ themes.json` | Generated theme configuration, autogenerated from `themesConfig.json`.|
307+
|`├─ js/` | |
308+
|`│ ├─ app.jsx` | Entry point of the ReactJS application. |
309+
|`│ ├─ appConfig.js` | Configuration of the qwc2 core modules. |
312310
|`│ ├─ Help.jsx` | Built-in component of custom Help dialog, see [Help dialog](#help-dialog). |
313311
|`│ └─ SearchProviders.js` | Built-in custom search providers, see [Search providers](#search-providers). |
314-
|`├─ icons/` | Application icons. |
315-
|`├─ qwc2/` | Git submodule containing the core qwc2 components. |
316-
|`├─ index.html` | Entry point. |
317-
|`├─ package.json` | NodeJS configuration file. |
318-
|`├─ themesConfig.json` | Themes configuration. |
319-
|`└─ webpack.config.js` | Webpack configuration. |
312+
|`├─ icons/` | Application icons. |
313+
|`├─ qwc2/` | Git submodule containing the core qwc2 components. |
314+
|`├─ index.html` | Entry point. |
315+
|`├─ package.json` | NodeJS configuration file. |
316+
|`└─ webpack.config.js` | Webpack configuration. |
320317

321318
### Application build-time configuration<a name="build-time configuration"></a>
322319

@@ -401,7 +398,7 @@ When adding or modifying translations at QWC2 components level, please contribut
401398

402399
### Selectively overriding translation strings
403400

404-
Occasionally, it is desireable to selectively override specific translation strings. While one can modify the full translation file as described above, especially when using the `qwc-map-viewer-demo` docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount).
401+
Occasionally, it is desireable to selectively override specific translation strings. While one can modify the full translation file as described above, especially when using the `qwc-map-viewer` docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount).
405402

406403
To do this:
407404

@@ -421,11 +418,11 @@ To do this:
421418
* Place this file inside the `translations` folder of your production build. When using `qwc-docker`, you can place this file in `qwc-docker/volumes/qwc2/translations/` and mount this file inside the container, i.e. :
422419
```yml
423420
qwc-map-viewer:
424-
image: sourcepole/qwc-map-viewer-demo:vYYYY.MM.DD
421+
image: sourcepole/qwc-map-viewer:vYYYY.MM.DD
425422
[...]
426423
volumes:
427424
- ./volumes/qwc2/translations/en-US_overrides.json:/qwc2/translations/en-US_overrides.json:ro
428425
```
429426
### Specifying the default fallback translation
430427

431-
When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as `defaultLocaleData` in `qwc2-app/js/appConfig.js`. For the demo viewer, the default fallback translation is `en-US`.
428+
When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as `defaultLocaleData` in `qwc2-app/js/appConfig.js`. For the stock application, the default fallback translation is `en-US`.

src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ qwc-services also provides the following enterprise relevant functionalities:
5555

5656
* [Developer Quickstart](QuickStart.md)
5757
* [User guide](UserGuide.md)
58-
* Some public viewers: [Demo](https://qwc2.sourcepole.ch) | [Glarus](https://map.geo.gl.ch/) | [Solothurn](https://geo.so.ch/map/) | [Oslandia](https://qgis.oslandia.net/) | [Erft Verband](http://webgis.erftverband.de)
58+
* Some public viewers: [QWC2 demo instance](https://qwc2.sourcepole.ch) | [Glarus](https://map.geo.gl.ch/) | [Solothurn](https://geo.so.ch/map/) | [Oslandia](https://qgis.oslandia.net/) | [Erft Verband](http://webgis.erftverband.de)
5959

6060
## Support
6161

62-
* Community support: [Github](https://github.com/qgis/qwc2-demo-app/issues)
62+
* Community support: [Github](https://github.com/qgis/qwc2/issues)
6363
* Commercial Support: [Sourcepole](https://www.sourcepole.com/), [Oslandia](https://oslandia.com/) and other companies.
6464
* [Improve this web site](https://github.com/qwc-services/qwc-services.github.io/)

src/release_notes/QwcDockerUpgradeNotes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
# Updating to qwc-map-viewer-demo-v2025.03.06
2+
3+
The `qwc-map-viewer-demo` images have been replaced by the `qwc-map-viewer` images (without the `-demo` suffix). Reference this image instead in your `docker-compose.yml`:
4+
5+
```yml
6+
qwc-map-viewer:
7+
- image: docker.io/sourcepole/qwc-map-viewer-demo:<tag>
8+
+ image: docker.io/sourcepole/qwc-map-viewer:<tag>
9+
```
10+
111
# Updating to qwc-permalink-service-v2024.12.14 \[2024-lts &rarr; 2025-lts\]
212
313
When updating to `qwc-permalink-service-v2024.12.14`, make sure to also update to `qwc-config-db-migrate-v2024.12.14` to update the schema of the `user_bookmarks` table. The bookmarks are now stored by user id instead of username.

src/topics/Search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,11 @@ searchProviders: [
172172
]
173173
...
174174
```
175-
Note: The `qwc2-demo-app` (also used by the `qwc-map-viewer-demo` docker image) includes four providers by default: `coordinates`, `nominatim` (OpenStreetMap location search), `qgis` (see <a href="#qgis-search">below</a>) and `fulltext` (see <a href="#fulltext-search">below</a>).
175+
Note: The `qwc2` stock application (also used by the `qwc-map-viewer` docker image) includes four providers by default: `coordinates`, `nominatim` (OpenStreetMap location search), `qgis` (see <a href="#qgis-search">below</a>) and `fulltext` (see <a href="#fulltext-search">below</a>).
176176

177177
## Configuring the QGIS feature search <a name="qgis-search"></a>
178178

179-
The QGIS feature search relies on WMS GetFeatureInfo with the [`FILTER`](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#wms-filter) parameter to search features of layers which are part of the theme WMS. It is enabled via the `qgis` search provider, which is part of the `qwc2-demo-app`.
179+
The QGIS feature search relies on WMS GetFeatureInfo with the [`FILTER`](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#wms-filter) parameter to search features of layers which are part of the theme WMS. It is enabled via the `qgis` search provider, which is part of the `qwc2` stock application.
180180

181181
*Note*: Make sure the QGIS Project is configured to return geometries with the feature info responses (`Project` &rarr; `Properties` &rarr; `QGIS Server` &rarr; `Add geometry to feature response`).
182182

src/topics/Snapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Snapping
22

3-
QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). To enable it, make sure the `SnappingSupport` plugin is enabled in `appConfig.js` (see the sample [sample `js/appConfig.js`](https://github.com/qgis/qwc2-demo-app/blob/master/js/appConfig.js)). Then, for each theme for which you want snapping to be available, you can add a `snapping` block to your theme item in `themesConfig.json` as follows:
3+
QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). The plugin is enabled in the stock application. To enable it in a custom application, make sure the `SnappingSupport` plugin is enabled in `appConfig.js` (see the sample [sample `js/appConfig.js`](https://github.com/qgis/qwc2-demo-app/blob/master/js/appConfig.js)). Then, for each theme for which you want snapping to be available, you can add a `snapping` block to your theme item in `themesConfig.json` as follows:
44
```json
55
...
66
"snapping": {

0 commit comments

Comments
 (0)