protocol agnostic decentralized social media client
Find a file
2024-11-01 19:13:21 -06:00
adapter change adapter API, implement honk::do::post 2024-11-01 19:13:21 -06:00
cli change adapter API, implement honk::do::post 2024-11-01 19:13:21 -06:00
frontend start implementing boost carousel 2024-08-31 11:01:31 -06:00
models change adapter API, implement honk::do::post 2024-11-01 19:13:21 -06:00
server refactor things to enable CLI mode 2024-09-28 11:39:03 -06:00
.gitignore refactor things to enable CLI mode 2024-09-28 11:39:03 -06:00
build.sh use static classes for Settings and AdapterState 2024-07-16 13:43:35 -06:00
go.mod local replace directive for go-misskey to bypass upstream bug 2024-06-23 10:34:29 -06:00
go.sum local replace directive for go-misskey to bypass upstream bug 2024-06-23 10:34:29 -06:00
package-lock.json cleanup node deps 2024-07-06 12:55:34 -06:00
package.json cleanup node deps 2024-07-06 12:55:34 -06:00
README.md refactor things to enable CLI mode 2024-09-28 11:39:03 -06:00
tsconfig.json clean up frontend build config 2024-07-07 11:07:18 -06:00
underbbs.go change adapter API, implement honk::do::post 2024-11-01 19:13:21 -06:00
webpack.config.js turn off minification and start refactoring web components 2024-08-04 11:48:51 -06:00

underBBS

underBBS is a protocol-agnostic decentralized social media client and toolkit

design

underbbs can run in two modes depending on its executable name:

web client

underbbs supports multiple simultaneous account logins, mediating them for each user through a gateway server that handles all protocol-specific logic via adapters 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

CLI

underbbs-cli pulls adapter credentials from ~/.config/underbbs/cli.conf and accepts commands on individual adapters, printing data to standard output.

building and running

requirements are

  • go 1.22
  • any recent nodejs that can do typescript and webpack 5

from the project root:

  1. ./build.sh front
  2. ./build.sh server
  3. ./underbbs

visit http://localhost:9090/app