Skip to content

doc: Add initial README.md #97

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

Merged
DutchBen merged 1 commit into from
Apr 30, 2026
Merged

doc: Add initial README.md #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Example Orchestrator UI

The `example-orchestrator-ui` provides a sample user interface for
[Workflow Orchestrator](https://workfloworchestrator.org). Many users will
start with this UI and eventually extend or customize a fork of this repo
to their own needs.

## Developing the Example Orchestrator UI

```sh
git clone git@github.com:workfloworchestrator/example-orchestrator-ui.git
cd example-orchestrator-ui
npm install
cp .env.example .env
# edit .env.example. You will likely want to set:
# OAUTH2_ACTIVE=false
npm run dev

# In a separate terminal, start the example-orchestrator so there's an API to
# query. This can also be pointed to another orchestrator instance.
git clone git@github.com:workfloworchestrator/example-orchestrator.git
cd example-orchestrator
docker compose up
```
Loading