diff --git a/README.rst b/README.rst index f739c5914..112e92e3c 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ GeoMapFish demo project ======================= -Read the `Documentation `_ +Read the `Documentation `_ Checkout -------- @@ -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 --------------- diff --git a/ui/README.md b/ui/README.md index 98a8ed854..518afa532 100644 --- a/ui/README.md +++ b/ui/README.md @@ -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. @@ -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