Skip to content

bitsocialhq/plebbit

 
 

Repository files navigation

Commitizen friendly

Plebbit

Plebbit is a decentralized reddit alternative for uncensored content. It is a fork of Seedit, a client (interface) for the Bitsocial protocol, which is a decentralized social network where anyone can create and fully own unstoppable communities. Learn more: https://bitsocial.net

Downloads


How to create a community

In the plebbit app, a bitsocial community is called a subplebbit. To run a subplebbit, you can choose between two options:

  1. If you prefer to use a GUI, download the desktop version of Plebbit, available for Windows, MacOS and Linux: latest release. Create a subplebbit using using the familiar old.reddit-like UI, and modify its settings to your liking. The app runs a P2P full node, meaning you have to keep it running to have your board online.
  2. If you prefer to use a command line interface, install bitsocial-cli, available for Windows, MacOS and Linux: latest release. Follow the instructions in the readme of the repo. When running the daemon for the first time, it will output WebUI links you can use to manage your community with the ease of the GUI.

Peers can connect to your subplebbit using any bitsocial client, such as 5chan or Seedit. They only need the subplebbit address, which is not stored in any central database, as bitsocial is a pure peer-to-peer protocol.

To run locally

  1. Install Node v22 (Download from https://nodejs.org)
  2. Install Yarn: npm install -g yarn
  3. yarn install --frozen-lockfile to install Seedit dependencies
  4. yarn start to run the web client

Scripts:

  • Web client: yarn start
  • Electron client (must start web client first): yarn electron
  • Electron client and don't delete data: yarn electron:no-delete-data
  • Web client and electron client: yarn electron:start
  • Web client and electron client and don't delete data: yarn electron:start:no-delete-data

Build:

The linux/windows/mac/android build scripts are in https://github.com/bitsocialhq/plebbit/blob/master/.github/workflows/release.yml

About

A Seedit fork for uncensored content

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 76.6%
  • CSS 12.9%
  • JavaScript 8.3%
  • Java 1.6%
  • Other 0.6%