Skip to content

Commit

Permalink
Add some run instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hojberg committed Nov 20, 2024
1 parent 584b6d6 commit e89f424
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ucm-desktop
# UCM Desktop
A desktop app companion to the UCM CLI. A.k.a. Graphical UCM.

---
Expand All @@ -8,3 +8,32 @@ This is currently an unreleased work in progress.
The goal is a UI that looks like this:

<img width="1872" alt="graphical-ucm" src="https://github.com/user-attachments/assets/34447b3d-4e1d-49c7-9171-634c09f5e1fb">

---

## Running
UCM desktop requires the UCM CLI to be running on a specific port and with a
specific UCM token
```bash
UCM_TOKEN=asdf UCM_PORT=4444 ucm headless --allow-cors-host tauri://localhost
```

If on windows, use this command instead:
```bash
UCM_TOKEN=asdf UCM_PORT=4444 ucm headless --allow-cors-host http://tauri.localhost
```

Then start the UCM Desktop app as you would normally.

## Running for development
When running for development start UCM like so:

```bash
UCM_TOKEN=asdf UCM_PORT=4444 ucm headless --allow-cors-host http://localhost:1420
```

Then start the app with:

```bash
npm start
```

0 comments on commit e89f424

Please sign in to comment.