diff --git a/docs/workshops/beginner/debian.md b/docs/workshops/beginner/debian.md index 10ad8a875..9a1c77064 100644 --- a/docs/workshops/beginner/debian.md +++ b/docs/workshops/beginner/debian.md @@ -102,25 +102,22 @@ PYTHONPATH=. python main.py db init PYTHONPATH=. python main.py db upgrade heads ``` -### Step 5 - Install orchestrator client +### Step 5 - Install orchestrator frontend Install the orchestrator client in the parent directory of the example-orchestrator: ```shell cd .. -git clone https://github.com/workfloworchestrator/orchestrator-core-gui.git +git clone https://github.com/workfloworchestrator/example-orchestrator-ui.git ``` -Install the Yarn package manager and use it to install the orchestrator -client dependencies: +Install the npm packages +`npm i` -```shell -cd orchestrator-core-gui/ -sudo npm install --global yarn -sudo npm install --global --save-dev npm-run-all -yarn install -``` +Set the environment variables. The defaults from .env.example will work out of the box with the example orchestrator backend. +`cp .env.example .env` +If you are working without authentication, be sure to set `OAUTH2_ACTIVE=true`. ### Step 6 - Init orchestrator client: diff --git a/docs/workshops/beginner/domain-models.md b/docs/workshops/beginner/domain-models.md index 5f154f39e..428fb9614 100644 --- a/docs/workshops/beginner/domain-models.md +++ b/docs/workshops/beginner/domain-models.md @@ -2,7 +2,7 @@ ## Introduction -First read the [Architecture; TL;DR](/orchestrator-core/architecture/tldr/) +First read the [Architecture TL;DR](docs/architecture/tldr.md) section of the orchestrator core documentation to get an overview of the concepts that will be covered. diff --git a/docs/workshops/beginner/macos.md b/docs/workshops/beginner/macos.md index 849b28001..e7005c506 100644 --- a/docs/workshops/beginner/macos.md +++ b/docs/workshops/beginner/macos.md @@ -107,7 +107,7 @@ example-orchestrator: ```shell cd .. -git clone https://github.com/workfloworchestrator/orchestrator-core-gui.git +git clone https://github.com/workfloworchestrator/example-orchestrator-ui.git ``` When multiple version of Node.js are installed, make sure node@14 is being @@ -115,7 +115,7 @@ used, this can be achieved by explicitly prepending it to the shell PATH. Use the Yarn package manager to install the orchestrator client dependencies: ```shell -cd orchestrator-core-gui/ +cd example-orchestrator-ui/ export PATH="/usr/local/opt/node@14/bin:$PATH" yarn install ``` diff --git a/docs/workshops/beginner/scenario.md b/docs/workshops/beginner/scenario.md deleted file mode 100644 index cc14732d7..000000000 --- a/docs/workshops/beginner/scenario.md +++ /dev/null @@ -1,18 +0,0 @@ -# Scenario - -During this workshop a set of products will be created together with the needed -workflows to administer users and user groups. The products will be just -complex enough to show the basic capabilities of products, product blocks, -fixed inputs, resource types and workflows in the workflow orchestrator. - -The following user and user group attributes will be stored: - -* **UserGroup** - * **group_name**: name of the user group - * **group_id**: ID of the group in an imaginary group management system -* **User** - * **affiliation**: the user's affiliation (**internal** or **external**) - * **username**: name of the user - * **age**: age of the user - * **user_id**: ID of the user in an imaginary user management system - * **group**: group the user belongs to diff --git a/docs/workshops/beginner/start-applications.md b/docs/workshops/beginner/start-applications.md index d5fe684b1..dbce35c44 100644 --- a/docs/workshops/beginner/start-applications.md +++ b/docs/workshops/beginner/start-applications.md @@ -10,21 +10,17 @@ From the `example-orchestrator` folder, use Uvicorn to start the orchestrator: uvicorn --host 127.0.0.1 --port 8080 main:app ``` +If you are running without authentication set up, you can set the environment variable to false from the command line: +``` +OAUTH2_ACTIVE=false uvicorn --host localhost --port 8080 main:app +``` + Visit [the app](http://127.0.0.1:8080/api/docs) to view the API documentation. ### Start client -From the `orchestrator-core-gui` folder, initialize your shell environment with -the variables from `.env.local` and start the client: - -``` -source .env.local -# on MacOS make sure node@14 is being used -export PATH="/usr/local/opt/node@14/bin:$PATH" -yarn start -``` - -Point a web browser to `$REACT_APP_BACKEND_URL`. +From the `example-orchestrator-ui` folder, run the following command to start the front end. +`npm run dev` ## Docker compose diff --git a/docs/workshops/beginner/overview.md b/docs/workshops/beginner/workshop-overview.md similarity index 76% rename from docs/workshops/beginner/overview.md rename to docs/workshops/beginner/workshop-overview.md index 93596ba51..a0b579189 100644 --- a/docs/workshops/beginner/overview.md +++ b/docs/workshops/beginner/workshop-overview.md @@ -1,4 +1,4 @@ -# Overview beginner workshop +# Beginner Workshop Overview ## Intended audience @@ -33,6 +33,24 @@ are prerequisites to do this workshop. as part of defining the create workflow. This will show how a simple product block hierarchy is created. + +During this workshop a set of products will be created together with the needed +workflows to administer users and user groups. The products will be just +complex enough to show the basic capabilities of products, product blocks, +fixed inputs, resource types and workflows in the workflow orchestrator. + +The following user and user group attributes will be stored: + +* **UserGroup** + * **group_name**: name of the user group + * **group_id**: ID of the group in an imaginary group management system +* **User** + * **affiliation**: the user's affiliation (**internal** or **external**) + * **username**: name of the user + * **age**: age of the user + * **user_id**: ID of the user in an imaginary user management system + * **group**: group the user belongs to + ## Workshop folder layout This workshop uses the following folder layout: @@ -67,7 +85,7 @@ beginner-workshop    └── ... ``` -The `orchestrator-core-gui` folder will be cloned from GitHub. The +The `example-orchestrator-ui` folder will be cloned from GitHub. The `example-orchestrator` folder will be used for the orchestrator that is created during this workshop. Although any layout of the latter folder will work, it is encouraged to use the suggested folder layout and filenames during this