Skip to content

Add Codespaces Configuration #1

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

Open
yilinxia wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add Codespaces Configuration #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1ed8f1
add codespace config
yilinxia Jun 30, 2023
4b3be2a
revise readme
yilinxia Jun 30, 2023
96dce81
revise codespaces instruction
yilinxia Jun 30, 2023
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
27 changes: 27 additions & 0 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# YesWorkflow Web Application


## Overview

The purpose of this repo to enable the service supporting the YesWorkflow web
Expand Down Expand Up @@ -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 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:

```
$ 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 web application 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:
Expand Down