mirror of
https://github.com/bitsocialnet/5chan.git
synced 2026-08-03 07:41:04 +02:00
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
<img src="https://github.com/plebeius-eth/assets/blob/main/plebchan-logo.jpg" width="378" height="123">
|
|
|
|
_Telegram group for this repo https://t.me/plebchanreact_
|
|
|
|
_Web client https://plebchan.eth.limo_
|
|
|
|
# Plebchan
|
|
|
|
Plebchan is a serverless, adminless, decentralized 4chan alternative where any pleb can create and own unlimited boards. All data comes from the plebbit protocol, it's all text including links from which media is embedded, shared peer-to-peer. Users do not need to register an account before participating in the community.
|
|
|
|
## To run locally
|
|
|
|
1. Install Node v18 (Download from https://nodejs.org)
|
|
2. Install Yarn: `npm install -g yarn`
|
|
3. `yarn install --frozen-lockfile` to install Plebchan 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/plebbit/plebchan/blob/master/.github/workflows/release.yml
|