https://github.com/unisonweb/unison-local-ui
The Codebase UI that ships with UCM
https://github.com/unisonweb/unison-local-ui
Last synced: about 1 year ago
JSON representation
The Codebase UI that ships with UCM
- Host: GitHub
- URL: https://github.com/unisonweb/unison-local-ui
- Owner: unisonweb
- License: mit
- Created: 2022-04-21T15:40:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T03:28:49.000Z (about 1 year ago)
- Last Synced: 2025-04-15T00:15:24.300Z (about 1 year ago)
- Language: Elm
- Size: 651 KB
- Stars: 16
- Watchers: 7
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unison Local UI
[](https://github.com/unisonweb/unison-local-ui/actions/workflows/ci.yml)
This is the UI you see when you type `ui` into `ucm`.
## Running Development Server
> 🔔 You should only need to run the UI development server if you're contributing to the UI. If you just want to run the UI to see your Unison codebase, it should either come pre-installed with `ucm` or if you built from source it can be downloaded with a script: `./dev-ui-install.hs` from the `unison` repository ([Running Unison](https://github.com/unisonweb/unison/blob/trunk/development.markdown#running-unison)).
1. Start `ucm` (the executable is `unison` instead of `ucm` if you built the [unison repository](https://github.com/unisonweb/unison) from source) in headless mode: `ucm headless`, and copy the API URL (this URL
is uniquely generated by `ucm` at start-up) from the `ucm` start-up output
(`ucm` also outputs a UI URL, but this isn't used when developing for the
UI/running the UI from this repository).
2. Make sure the latest dependencies are installed with by running `npm install` followed by `npm run ui-core-install`.
3. Start the dev server with: `API_URL="" npm start`
4. Visit `http://localhost:1234` in a browser.
> 💡 Set the environment variable `ELM_DEBUG=1` before starting the dev server to enable Elm's time-travelling debugger.
## Dependencies
This depends on the [ui-core package](https://github.com/unisonweb/ui-core) via
[elm-git-install](https://github.com/robinheghan/elm-git-install). That package
includes both the Unison design system, and a core set of components for
working with and rendering Unison definitions and
namespaces.
## Bumping [ui-core package](https://github.com/unisonweb/ui-core)
The UI Core dependency can be updated to its latest version with this command:
```bash
npm run ui-core-update
```
To install a specific sha:
```bash
npm run ui-core-install -- [SOME_UI_CORE_SHA]
```
## Community
[Code of conduct](https://www.unisonweb.org/code-of-conduct/)