Skip to content
This repository has been archived by the owner on Jul 19, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hojberg committed Jul 19, 2022
1 parent bb0747a commit 02cf50b
Showing 1 changed file with 2 additions and 30 deletions.
32 changes: 2 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,4 @@
Unison Codebase UI
==================

[![CI](https://github.com/unisonweb/codebase-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/unisonweb/codebase-ui/actions/workflows/ci.yml)

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 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`

3. Start the Unison Share dev server with: `API_URL="<API URL FROM UCM>" npm run start:unisonShare` or the Unison Local dev server with: `API_URL="<API URL FROM UCM>" npm run start:unisonLocal`

4. Visit `http://localhost:1234` in a browser.

Adding new Icons
----------------

To add new icons, copy the SVG markup to a new function in `/src/UI/Icon.elm`
following the convention seen there of other icons. The color (`fill` or
`stroke`) of the shape must be
[`currentColor`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/color).

Community
--------
[Code of conduct](https://www.unisonweb.org/code-of-conduct/)
This is now archived version of the UI.
[Unison Local UI](https://github.com/unisonweb/unison-local-ui) and [UI Core](https://github.com/unisonweb/ui-core) has replaced this repository.

0 comments on commit 02cf50b

Please sign in to comment.