BobaBoard is a modern, open source community-building software that draws inspiration from old-school forums for functionality and from modern social media for its style of interaction. It prioritizes privacy and fluidity of identity for users within communities and allows high levels of customization and fine-grained permission settings for users, community managers, and instance owners. The unique UX encourages creative expression across different formats, styles of communication, and community building.
You can find out more about BobaBoard in general on our website and as a project by visiting our project guide.
boba-docs is a monorepo containing the documentation for BobaBoard, as well as some docusaurus plugins we use to pull some of our data directly from our GitHub organization.
The monorepo aspect is managed through Turborepo with yarn workspaces handling each "sub-package".
📝 NOTE: Turborepo is not compatible with native Windows. Windows users will need to install WSL to edit the documentation. For more information on installing WSL see The BobaBoard Guide to Installing WSL.
yarn install
yarn run start
We currently have 2 groups of workspaces:
- docusaurus/: contains our docusaurus installation
- plugins/*: contains a subfolder for each docusaurus plugin maintained as part of this monorepo
Choose your poison:
This is similar to running yarn add, but slightly longer:
yarn workspace [workspacename-name] add.
For example, you can run: yarn workspace docusaurus add @package/name.
Documentation is on the Turborepo website.
Run the regular yarn add command from within the workspace folder
cd workspace/folder
yarn add @package/name
Remember to still run yarn run start from the root directory.
Important
Our issue tracker is not up-to-date and we are specifically looking for people to help us wrangle issues into order. If you're very eager to start working, please contact us through our tech form (for coding) or our non-tech form (for issue wrangling).
BobaBoard welcomes one-time contributions. Our volunteer Code of Conduct applies in all of our social spaces, including Github Discussions or when commenting on issues or pull requests.
We are also always looking for long-term volunteers to help with coding, documentation, and other efforts. If you'd like to become a BobaBoard volunteer, please see the Volunteering Guide for details.
