https://github.com/urbit/webterm

tui client for the web
https://github.com/urbit/webterm

Last synced: 4 days ago
JSON representation

tui client for the web

• Host: GitHub
• URL: https://github.com/urbit/webterm
• Owner: urbit
• Created: 2023-02-17T20:03:15.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-20T18:38:49.000Z (9 months ago)
• Last Synced: 2024-08-03T01:13:02.698Z (3 months ago)
• Language: TypeScript
• Size: 650 KB
• Stars: 4
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-urbit - Terminal

README

        
# Webterm

Interactive web mirror of your Urbit's text interface. Speaks the dill protocol as proxied through `/app/herm`, which comes bundled with the base distribution.

Emulates a terminal using XTerm.js, and simply mimics vere's behavior inside of that for drawing dill blits. Slogs (printfs) get pulled in from vere's `/~_~/slog` endpoint, and rendered in similar fashion. Supports multiple sessions through simple tabs.

## Getting started

The usual suspects: in the `/ui` directory, `npm install`, then `npm run dev` to start the dev server. This pulls the ship URL to proxy to from a `/ui/.env.local` file, which should contain a `VITE_SHIP_URL='http://localhost:8080'` or similar. `npm run build` to build a bundle. Glob as normal.

## Deploying

[[ interested? your gh automation here! ]]