BobaBoard's codebase is split within 4 separate repositories:

• BobaEditor (codebase | demo): A text editor based on QuillJS. All text formatted by users is created through this editor and stored in the DB in Quill "Delta" format, an abstract representation of formatted text that can be translated into HTML through various parsers.

This is the codebase you want if you want to give users more input options, including embeds, images and gifs.

MIT licensed. Released (very irregularly) as a npm package at @bobaboard/boba-editor.

• Component System (codebase | demo): These are all the UI components BobaBoard uses in its frontend, as separated from the business logic as possible. We use Storybook as a base to develop them independently. The maybe-misguided hope is that people who want a different look for BobaBoard might one day be able to simply fork this part of the codebase.

This is the codebase you want if you want to change (or improve) the functionality/look of Buttons, Posts, Sidebars, Threads and all that.

MIT licensed. Released (very irregularly) as a npm package at @bobaboard/bobaboard-ui.

• BobaBoard Frontend (codebase): As implied, the BobaBoard frontend repository. Takes care of routing, querying the server and translating data for the component system, and all the frontend business logic. Based on NextJS.

This is the codebase you want if you want to add/change actual functionality and pages to the BobaBoard website.

The repository is currently private, so you'll have to request access. Likely license is aGPLv3.

• BobaBoard Backend (codebase): As implied, the BobaBoard backend repository, including DB schema. This is where the pie gets made. It's an ExpressJS server and communicates with the BobaBoard Frontend through a REST API. This is backed by a CircleCI continuous integration pipeline for testing, which is currently broken.

This is the codebase you want for anything that doesn't have to do with what's visible to the user.

The repository is currently private, so you'll have to request access. Likely license is aGPLv3.

External Packages

You can read more about other technologies we've been using in External Packages/Components.

As in many software projects, many things are held together with hopes, spit and dreams (and some tech debt). If you see something that's not configured as well as it should be, and want to try your hand at fixing it, you're encouraged to contact me to get the historical context and brave the wilderness.

Getting Started

Setting Up Your DevEnv