Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
manisandro committed Mar 6, 2025
1 parent 363bea3 commit a1631f4
Showing 1 changed file with 28 additions and 40 deletions.
68 changes: 28 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,34 @@ QGIS Web Client 2 Demo Application

QGIS Web Client 2 (QWC2) is a modular next generation responsive web client for QGIS Server, built with ReactJS and OpenLayers.

This repository contains a sample QWC2 application.

Some examples of QWC2 production deployments:

- [QWC2 demo server](http://qwc2.sourcepole.ch)
- [GeoViewer Kanton Glarus](https://map.geo.gl.ch/)
- [Web GIS Client Kanton Solothurn](https://geo.so.ch/map/)

## [Quick start](https://qwc-services.github.io/master/QuickStart/)
## [Documentation](https://qwc-services.github.io/)
## [QWC2 extended with microservices](https://github.com/qwc-services/qwc-docker)
## [Upgrade notes](https://qwc-services.github.io/master/release_notes/QWC2UpgradeNotes/)
## [Mailing list](https://lists.osgeo.org/mailman/listinfo/qgis-qwc2)

![Screenshot](https://github.com/qgis/qwc2-demo-app/blob/gh-pages/Screenshot.jpg?raw=true)

# Main Features

- Modular and easily configurable and extensible
- Responsive, separately configurable for desktop and mobile devices
- Theme switcher
- Arbitrarily configurable search providers
- Layer tree
* Toggle layers and groups
* Change layer order and opacity
- Import external WMS/WFS/WMTS/GeoJSON/KML layers
- Feature info
- Compare layers
- Share permalinks
- Bookmarks
- Measuring tools
- Height profile
- Redlining
- Editing
- Attribute table
- DXF export
- Raster export
- Printing
- Time manager for temporal layers
- Themeable with color schemes
This repository contains an example skeleton for building a custom QWC2 application based on the [QWC2 stock application](https://github.com/qgis/qwc2).

Consult the [QWC2 README](https://github.com/qgis/qwc2/blob/master/README.md) for information about QWC2, and further links to documentation, sample viewers, etc.

# Quick start

To build a custom application based on the QWC2 stock application, follow these steps:

1. Clone this repository

git clone --recursive https://github.com/qgis/qwc2-demo-app

2. Make sure the submodule is up to date

cd qwc2
git pull

3. Install dependencies

yarn install

5. Run the development server

yarn start

6. Edit `js/appConfig.js` to include your custom components

See [Building a custom viewer](https://qwc-services.github.io/master/configuration/ViewerConfiguration/#building-a-custom-viewer) for further information.

# License

Expand Down

0 comments on commit a1631f4

Please sign in to comment.