underbbs/README.md

20 lines
1011 B
Markdown
Raw Normal View History

2024-04-22 00:02:44 +00:00
# underBBS
underBBS is a platform-agnostic messaging and social media client
2024-07-07 17:07:18 +00:00
## design
`underbbs` supports multiple simultaneous account logins, mediating them for each user through a gateway server that handles all protocol-specific logic via `adapter`s and streaming content to the user through a single websocket connection with a singular data interface.
each distinct `adapter` connection/configuration is represented in the frontend as a tab, and using the websocket's event-driven javascript interface with web components we can simply either store the data or tell the currently visible adapter that it might need to respond to the new data
adapters receive commands via a quartzgun web API and send data back on their shared websocket connection
2024-04-22 00:02:44 +00:00
## building
2024-07-07 17:07:18 +00:00
requirements are
- go 1.22
- any recent nodejs that can do `typescript` and `webpack` 5
run `./build.sh` from the project root. you can supply 'front' or 'server' as an argument to build only one or the other; by default it builds both