hagl / codebase-ui

Unison Codebase UI

Unison Codebase UI

Hacktoberfest 2021

🎃 Unison is participating in Hacktoberfest! There's a number of ways to contribute:

1. Look for issues tagged with #hacktoberfest in the Unison language repo or the Unison Codebase UI repo
2. Add contributions like missing functions and docs to our base library
3. Author your own library and submit a PR to the Share repository

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).

1. Start ucm (the executable is unison instead of ucm if you built the unison repository 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 development server, run: API_URL="<API URL FROM UCM>" npm start

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.

Community

Code of conduct