From c1ed8f1557a0756cff0c66b5d22de4f056e584a1 Mon Sep 17 00:00:00 2001 From: Yilin Xia Date: Fri, 30 Jun 2023 03:05:15 +0000 Subject: [PATCH 1/3] add codespace config --- .devcontainer/devcontainer.json | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..7e0d589 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,27 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu +{ + "name": "Ubuntu", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/base:jammy", + "features": { + "ghcr.io/devcontainers/features/docker-in-docker:2": {}, + "ghcr.io/devcontainers/features/github-cli:1": {}, + "ghcr.io/jungaretti/features/make:1": {} + } + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "uname -a", + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} From 4b3be2aa7e33891ba79fc81f7e7a7e01b05b1559 Mon Sep 17 00:00:00 2001 From: Yilin Xia Date: Fri, 30 Jun 2023 03:31:07 +0000 Subject: [PATCH 2/3] revise readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 86d695e..a9c56d9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # YesWorkflow Web Application + ## Overview The purpose of this repo to enable the service supporting the YesWorkflow web @@ -95,6 +96,24 @@ Perform the following steps on a computer running Linux, MacOS, or Windows. 6. Navigate to the web application in your browser at http://localhost:8080. +## Running the service with GitHub Codespaces +1. Create a Codespaces by clickling the link below +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/yilinxia/yw-web-app) +2. Once the Codespaces created, you can start the service by invoking the `run` target: + + ``` + $ make run + + docker run -it --rm -p 8080:8080 --volume C:/Users/tmcphill/GitRepos/yw-web-app:/mnt/yw-web-app cirss/yw-web-app:latest bash -ic /mnt/yw-web-app/service/run.sh + + -------------------------------------------------------------------------- + The YesWorkflow web app service has been started in the REPRO. + Connect to it by navigating in a web browser to http://localhost:8080 + + Terminate the service by typing CTRL-C in this terminal. + --------------- +3. Open the link (Note: If you encounter any error, you can refresh the page, or access the WebAPP from `PORTS -> Local Address`) + ## Running the service on a Windows system without Make There are two alternatives for running the YesWorkflow web app service on Windows systems: From 96dce8174cbf9d4db23ed32c267815660516b700 Mon Sep 17 00:00:00 2001 From: Yilin Xia Date: Fri, 30 Jun 2023 03:41:45 +0000 Subject: [PATCH 3/3] revise codespaces instruction --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a9c56d9..bc1aba7 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ Perform the following steps on a computer running Linux, MacOS, or Windows. 6. Navigate to the web application in your browser at http://localhost:8080. ## Running the service with GitHub Codespaces -1. Create a Codespaces by clickling the link below +1. Create a Codespaces by clicking [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/yilinxia/yw-web-app) 2. Once the Codespaces created, you can start the service by invoking the `run` target: @@ -112,7 +112,7 @@ Perform the following steps on a computer running Linux, MacOS, or Windows. Terminate the service by typing CTRL-C in this terminal. --------------- -3. Open the link (Note: If you encounter any error, you can refresh the page, or access the WebAPP from `PORTS -> Local Address`) +3. Open web application from `PORTS -> Local Address` ## Running the service on a Windows system without Make