cabal-club / cabal-club/cabal-cli
Add --ws option to launch web sockets server
- Dominant language
- JavaScript
- Stars
- 525
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
@nikolaiwarner's been working on splitting up https://github.com/cabal-club/cabal-desktop/ components so that they can be used in a browser-based cabal application. As far as I know, it currently uses a websocket server to relay messages. (A similar approach to what I've done in https://github.com/cblgh/cabal-crepes/tree/wip-wss)
Since we already use the cli client to seed cabal instances with `cabal --seed`, I thought it would be excellent to enable an easily launched web socket server in the background, too.
`--ws` could accept as its argument the port used to host the websocket server.
This would mean that any cabal-cli instance could also easily double as a web socket server for the first version of browser-based clients, afaik @perguth has, together with his company, been wanting a way to use Cabal in a browser without everyone participating needing to host all of the content, so this idea would enable that usecase.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the CLI option handling for --seed and searching the project for its existing websocket-related code. Confirm the desired --ws port behavior and that a launched cabal-cli instance can relay browser-client messages; done should include coverage for option parsing and server startup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli, networking
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100