|
1 | 1 | # OMS Web Application |
2 | 2 |
|
3 | | -This repository contains a web application that enables one to interact with the Order |
4 | | -Management System (OMS) reference application. Code for the OMS is maintained in the |
| 3 | +This repository contains a web application that enables one to interact with the Order |
| 4 | +Management System (OMS) reference application. Code for the OMS is maintained in the |
5 | 5 | [reference-app-orders-go](https://github.com/temporalio/reference-app-orders-go) |
6 | | -repository. Since this web application depends on services provided by the OMS, you will |
7 | | -need code from both repositories to run it. |
| 6 | +repository. Since this web application depends on services provided by the OMS, you will |
| 7 | +need code from both repositories to run it. |
8 | 8 |
|
9 | | -The steps below minimally cover how to run and build the web application. See the |
10 | | -[other repository](https://github.com/temporalio/reference-app-orders-go) |
11 | | -for detailed instructions on running and using the Order Management System. |
| 9 | +The steps below minimally cover how to run and build the web application. See the |
| 10 | +[other repository](https://github.com/temporalio/reference-app-orders-go) |
| 11 | +for detailed instructions on running and using the Order Management System. |
12 | 12 |
|
| 13 | +Uses Svelte5 and Tailwind4 |
13 | 14 |
|
14 | 15 | ## Running the Web Application Locally |
15 | 16 |
|
16 | | -After you start the API servers and one or more Workers, as [described in the |
17 | | -OMS instructions](https://github.com/temporalio/reference-app-orders-go?tab=readme-ov-file#quickstart), |
| 17 | +After you start the API servers and one or more Workers, as [described in the |
| 18 | +OMS instructions](https://github.com/temporalio/reference-app-orders-go?tab=readme-ov-file#quickstart), |
18 | 19 | run the following [`pnpm`](https://pnpm.io/) commands from the root directory of this project: |
19 | 20 |
|
20 | 21 | ```bash |
21 | 22 | pnpm i |
22 | 23 | pnpm dev |
23 | 24 | ``` |
24 | 25 |
|
25 | | -This starts a local server. You can navigate to http://127.0.0.1:5173/ to view the web application. |
26 | | - |
27 | | -NOTE: As a workaround for deployment to [GitPod](https://gitpod.io/), in which the domain of each application |
28 | | -container is assigned dynamically, this application [disables the CSRF origin check](https://github.com/temporalio/reference-app-orders-web/blob/5a1044ddae5a5f110263b9c464f576384d533036/svelte.config.js#L10-L12). [Pull request #6](https://github.com/temporalio/reference-app-orders-web/pull/6) describes this in more detail, and we recommend reinstating this origin check for improved security in a |
29 | | -real-world deployment. |
| 26 | +This starts a local server. You can navigate to http://127.0.0.1:5173/ to view the web application. |
30 | 27 |
|
| 28 | +NOTE: As a workaround for deployment to [GitPod](https://gitpod.io/), in which the domain of each application |
| 29 | +container is assigned dynamically, this application [disables the CSRF origin check](https://github.com/temporalio/reference-app-orders-web/blob/5a1044ddae5a5f110263b9c464f576384d533036/svelte.config.js#L10-L12). [Pull request #6](https://github.com/temporalio/reference-app-orders-web/pull/6) describes this in more detail, and we recommend reinstating this origin check for improved security in a |
| 30 | +real-world deployment. |
31 | 31 |
|
32 | 32 | ## Building the Web Application |
33 | 33 |
|
34 | 34 | Run `pnpm build` to create a production version of your app. You can then preview the production build by |
35 | 35 | running `pnpm preview`. |
36 | 36 |
|
37 | | -The [`.github/workflows/docker-publish.yml`](https://github.com/temporalio/reference-app-orders-web/blob/main/.github/workflows/docker-publish.yml) |
38 | | -file automates the creation and publication of Docker images in response to code changes. |
| 37 | +The [`.github/workflows/docker-publish.yml`](https://github.com/temporalio/reference-app-orders-web/blob/main/.github/workflows/docker-publish.yml) |
| 38 | +file automates the creation and publication of Docker images in response to code changes. |
0 commit comments