Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix UI README #1517

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Fix UI README #1517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GeoMapFish demo project
=======================

Read the `Documentation <https://camptocamp.github.io/c2cgeoportal/2.8/>`_
Read the `Documentation <https://camptocamp.github.io/c2cgeoportal/2.9/>`_

Checkout
--------
Expand Down Expand Up @@ -38,6 +38,11 @@ If you use the default database (as configured in the env.project file), you mus

If you modify the content of the `geoportal` folder and want to use these changes, you must comment this line to use the correct image with you local composition: https://github.com/camptocamp/demo_geomapfish/blob/a319b78a0a381204ff90bf4d9dd5ab8fa60f4e95/docker-compose.yaml#L100

Custom UI
---------

If you want to develop customs interfaces, look at the README in the `ui` folder.

Backup database
---------------

Expand Down
15 changes: 9 additions & 6 deletions ui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
The renovate interface is the desktop, mobile and iframe_api interfaces from ngeo that uses the
ngeo library directly (renovated).

This `ui` folder has been created manually. It's using ngeo as base library but any kind of UI interface can
be integrated.

## Development

The server application should be started previously, see the documentation from the main README.
Expand All @@ -18,16 +21,16 @@ Open the application in your browser at [https://localhost:3002/static-frontend/

## Integration in the application

- [Build in the config image](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/Dockerfile#L92C1-L101C38).
- [Put the files in the `/etc/static-frontend/` folder](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/Dockerfile#L111C8-L111C29).
- The interfaces declaration [desktop](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/geoportal/vars.yaml#L51-L53), [mobile](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/geoportal/vars.yaml#L55-L57) and [iframe_api](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/geoportal/vars.yaml#L45-L47).
- The interfaces configuration [desktop](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/geoportal/vars.yaml#L373-L379), [mobile](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/geoportal/vars.yaml#L495-L497) and [iframe_api](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/geoportal/vars.yaml#L503-L504).
- [Build in the config image](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/Dockerfile#L93-L101).
- [Put the files in the `/etc/static-frontend/` folder](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/Dockerfile#L111).
- The interfaces declaration [desktop](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/geoportal/vars.yaml#L51-L53), [mobile](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/geoportal/vars.yaml#L55-L57) and [iframe_api](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/geoportal/vars.yaml#L45-L47).
- The interfaces configuration [desktop](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/geoportal/vars.yaml#L373-L381), [mobile](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/geoportal/vars.yaml#L497-L499) and [iframe_api](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/geoportal/vars.yaml#L505-L506).
- The Interfaces should also be created in the admin interface.

## Build details

- [Alias required by ngeo](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/ui/vite.config.js#L41-L45).
- [Alias created to reduce the build size](https://github.com/camptocamp/demo_geomapfish/blob/standalone-ngeo-ui-sbr/ui/vite.config.js#L47-L62).
- [Alias required by ngeo](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/ui/vite.config.js#L47-L51).
- [Alias created to reduce the build size](https://github.com/camptocamp/demo_geomapfish/blob/70ee2a0d4f2e265dc44d8da57f7e42dc9d09ff8c/ui/vite.config.js#L53-L68).

## Interfaces

Expand Down