Skip to content

Commit

Permalink
Revised README.md
Browse files Browse the repository at this point in the history
I revised the README to provide a little more depth, include a link to the pnpm command (in case the user didn't have it installed), and made it clear that the other repo will be the main source of documentation about the OMS.
  • Loading branch information
tomwheeler authored Jul 1, 2024
1 parent 48f9bc1 commit bd7b8bf
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,34 @@
# OMS Web Interface
# OMS Web Application

This repository contains the web application corresponding to the Order Management System reference
application, code for which is found in the [reference-app-orders-go](https://github.com/temporalio/reference-app-orders-go)
repository. To run this application, you will need code from both repositories.
This repository contains a web application that enables one to interact with the Order
Management System (OMS) reference application. Code for the OMS is maintained in the
[reference-app-orders-go](https://github.com/temporalio/reference-app-orders-go)
repository. Since this web application depends on services provided by the OMS, you will
need code from both repositories to run it.

## Running locally
The steps below minimally cover how to run and build the web application. See the
[other repository](https://github.com/temporalio/reference-app-orders-go)
for detailed instructions on running and using the Order Management System.


## Running the Web Application Locally

After you start the API servers and one or more Workers, as [described in the
OMS instructions](https://github.com/temporalio/reference-app-orders-go?tab=readme-ov-file#quickstart),
run the following [`pnpm`](https://pnpm.io/) commands from the root directory of this project:

```bash
pnpm i
pnpm dev
```

Navigate to http://127.0.0.1:5173/ to view UI.
This starts a local server. You can navigate to http://127.0.0.1:5173/ to view the web application.

## Building

To create a production version of your app:
## Building the Web Application

```bash
pnpm build
```
Run `pnpm build` to create a production version of your app. You can then preview the production build by
running `pnpm preview`.

You can preview the production build with `pnpm preview`.
The [`.github/workflows/docker-publish.yml`](https://github.com/temporalio/reference-app-orders-web/blob/main/.github/workflows/docker-publish.yml)
file automates the creation and publication of Docker images in response to code changes.

0 comments on commit bd7b8bf

Please sign in to comment.