From f1fb9097284cf23e527b0ab3376d5009844d775d Mon Sep 17 00:00:00 2001 From: Christian Mayer Date: Tue, 4 Jun 2024 14:24:10 +0200 Subject: [PATCH 1/2] Update project's README --- README.md | 47 +++++++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 71fabada..96c84039 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,13 @@ We look forward to your contributions! ## Versions -The latest development points towards a Wegue version v2. This development is reflected within the `master` branch. -Herewith some breaking changes come along. In case you have to remain on the v1.x version of Wegue you can use the latest release [v1.2.1](https://github.com/wegue-oss/wegue/releases/tag/v1.2.1) or to the maintenance development of v1 in the [v1 branch](https://github.com/wegue-oss/wegue/tree/v1). For a reasonable amount of time `v1` branch will be maintained. At least until there is an official `v2` release plus some additional buffer time. +The lastest stable and released version stream is 2.x. -In case you want to upgrade an existing Wegue app from v1 to the current v2 development stream please have a look at the `upgrade-notes.md` file. +The latest developments are reflected within the `master` branch. We always try to have a robust state at the `master` branch, but be aware that breaking changes could come along. + +In case you have to remain on the 1.x version of Wegue you can use the latest release [v1.2.1](https://github.com/wegue-oss/wegue/releases/tag/v1.2.1) or the maintenance development of v1 in the [v1 branch](https://github.com/wegue-oss/wegue/tree/v1). For a reasonable amount of time `v1` branch will be maintained. + +In case you want to upgrade an existing Wegue app from v1 to the current v2 stream please have a look at the `upgrade-notes.md` file. ## Development @@ -120,41 +123,45 @@ Besides the environment variables supported by Vue CLI Wegue offers the followin ## Run with Docker -Versioned Docker images are available on [DockerHub](https://hub.docker.com/r/meggsimum/wegue/tags). -Run the `latest` (`master`) version of the Wegue Docker Image as follows: +The shipped Dockerfile gives you a basic idea how to use Wegue with Docker. +Maybe the Dockerfile needs some modification if you use custom application code. +Once you get along with just modifying the application config JSON it should be sufficient to do the following steps: + +Build a Wegue Docker image as follows: + +``` bash +docker build -t my-wegue-img:latest . +``` + +Start the freshly build image as container: ``` bash -docker run -it -p 8080:80 meggsimum/wegue:latest +docker run -it -p 8080:80 my-wegue-img:latest ``` Open - - http://127.0.0.1:8080/ or - - http://localhost:8080/?appCtx=minimal or - - http://localhost:8080/?appCtx=projected + +- or +- or +- in a browser. -Use Docker Volume Mapping to run with your custom Wegue JSON config: +Use Docker Volume mapping to run with your custom Wegue JSON config: ``` bash -docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf-mine.json meggsimum/wegue:latest +docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf-mine.json my-wegue-img:latest ``` -and open http://localhost:8080/?appCtx=mine. +and open . You can even overwrite the default config `app-conf.json`: ``` bash -docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf.json meggsimum/wegue:latest +docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf.json my-wegue-img:latest ``` -and then open http://localhost:8080/. - -Build a Wegue Docker Image as follows: - -``` bash -docker build -t meggsimum/wegue:latest . -``` +and then open . ## Developing online using Gitpod.io From 894ad411e6336790b463867637696027e73aa961 Mon Sep 17 00:00:00 2001 From: Christian Mayer Date: Wed, 5 Jun 2024 16:15:34 +0200 Subject: [PATCH 2/2] Apply suggestions from code review #395 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jakob Miksch Co-authored-by: Sébastien Ronveaux <57899415+sronveaux@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96c84039..b2f5a64f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ The latest developments are reflected within the `master` branch. We always try In case you have to remain on the 1.x version of Wegue you can use the latest release [v1.2.1](https://github.com/wegue-oss/wegue/releases/tag/v1.2.1) or the maintenance development of v1 in the [v1 branch](https://github.com/wegue-oss/wegue/tree/v1). For a reasonable amount of time `v1` branch will be maintained. -In case you want to upgrade an existing Wegue app from v1 to the current v2 stream please have a look at the `upgrade-notes.md` file. +In case you want to upgrade an existing Wegue app from v1 to the current v2 stream please have a look at the [upgrade-notes.md](upgrade-notes.md) file. ## Development @@ -133,7 +133,7 @@ Build a Wegue Docker image as follows: docker build -t my-wegue-img:latest . ``` -Start the freshly build image as container: +Start the freshly build image as a container: ``` bash docker run -it -p 8080:80 my-wegue-img:latest