Soapbox mirror
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Alex Gleason c64b7d8ba9
Overhaul README
2 years ago
.github Move FUNDING.yml to .github/FUNDING.yml 2 years ago
.gitlab Add default MR template 2 years ago
.husky Use lint-staged with Husky to only lint changed files 3 years ago
.vscode soapbox-pub/soapbox-fe --> soapbox-pub/soapbox 2 years ago
app Fix demo mode 2 years ago
custom Revert "Replace 'send' icon from Tabler" 2 years ago
docs These instructions are outdated with a 1.3.0 install. 2 years ago
installation Docker: open fallback backend at :4444 2 years ago
jest Upgrade Jest to v28 2 years ago
tailwind Remove unused sea-blue color 2 years ago
types translationRunner: convert to TypeScript 2 years ago
webpack Revert "Remove 'show on map' for now" 2 years ago
.dockerignore dockerignore: .git 2 years ago
.editorconfig Add .editorconfig 4 years ago
.env.example Patron updates 4 years ago
.eslintignore eslintignore: /custom/** 2 years ago
.eslintrc.js Fix conflict between eslint / typescript 2 years ago
.gitattributes Add .gitattributes, prevent conflicts on CHANGELOG.md 2 years ago
.gitignore Produce a junit.xml during test:coverage 2 years ago
.gitlab-ci.yml GitLab CI: let deps job be interrupted 2 years ago
.lintstagedrc.json Revert "Merge branch 'revert-f59d977a' into 'develop'" 2 years ago
.stylelintrc.json Start adding dark mode 2 years ago
.tool-versions Upgrade to Node 18 2 years ago
CHANGELOG.md CHANGELOG: add i18n notes 2 years ago
COFE_OF_CONDUCT.md Replace code of conduct with cofe of conduct 4 years ago
Dockerfile Docker: open fallback backend at :4444 2 years ago
Dockerfile.dev Support Docker local development 2 years ago
LICENSE Add LICENSE and README 4 years ago
README.md Overhaul README 2 years ago
app.json Add app.json 2 years ago
babel.config.js Remove @ decorators 2 years ago
compose-dev.yaml Support Docker local development 2 years ago
dangerfile.ts Danger: don't warn about changelog for docs, CI, etc 2 years ago
heroku.yml Add heroku.yml so it uses the Dockerfile 2 years ago
jest.config.js Delete custom locale-data 2 years ago
jsdoc.conf.js Rename files (14): cleanup misc v2 2 years ago
package.json Revert "Remove 'show on map' for now" 2 years ago
postcss.config.js Add Tailwind 2 years ago
renovate.json Renovate: add GitHub access token for release notes 4 years ago
soapbox-screenshot.png Overhaul README 2 years ago
tailwind.config.js Remove unused sea-blue color 2 years ago
translationRunner.ts translationRunner: improve types 2 years ago
tsconfig.json Remove @ decorators 2 years ago
webpack.config.ts Convert Webpack configuration to TypeScript 2 years ago
yarn.lock Revert "Remove 'show on map' for now" 2 years ago

README.md

Soapbox Screenshot

Soapbox is customizable open-source software that puts the power of social media in the hands of the people. Feature-rich and hyper-focused on providing a user experience to rival Big Tech, Soapbox is already home to some of the biggest alternative social platforms.

On The Fediverse

You may have heard of Mastodon. Soapbox builds upon what Mastodon made great to make something even better.

You can run Mastodon+Soapbox, Rebased+Soapbox, and more.

Soapbox is the frontend (what users see) while Mastodon is the backend (data, APIs). You can mix-and-match in the Fediverse ecosystem.

💡 If you're starting a new server, we highly recommend Rebased+Soapbox. Rebased is our custom-built backend just for Soapbox, providing important new features such as quote posting and chats.

See: Installing Rebased+Soapbox

Try It Out

Want to give Soapbox a shot? Here are some suggested servers:

Want to use Soapbox against any existing Mastodon/Pleroma server? Try:

  • fe.soapbox.pub - enter your server's domain name to use Soapbox on any server!

🚀 Starting Your Own Server

Starting your own server is one of the best ways to have freedom online! We recommend installing Rebased+Soapbox.

See here for a detailed setup guide: Installing Rebased+Soapbox

Adding Soapbox to an Existing Server

Already have a server? No problem — it is still possible to use Soapbox.

💡 If using Pleroma, it's recommended to upgrade it to Rebased. This comes with better support and many new features, helping you get the most out of Soapbox.

Developing Soapbox

tl;dr — git clone, yarn, and yarn dev.

For detailed guides, see these pages:

  1. Soapbox local development
  2. yarn commands
  3. How it works
  4. Environment variables
  5. Developing a backend

Contributing

We welcome contributions to this project. To contribute, see Contributing to Soapbox.

Translators can help by providing translations through Weblate. Native speakers from all around the world are welcome!

Project Philosophy

Soapbox was born out of the need to build independent platforms with a unique identity and brand.

This is in contrast to Mastodon's idea, where all servers are called "Mastodon" and use the Mastodon colors and logo. Users won't see the word "Soapbox" throughout the UI, they'll see the name of your website and your logo. To facilitate this, Soapbox has a robust customization UI and integrated moderation tools. Large servers are a priority.

One disadvantage of this approach is that it does not help the software spread. Some of the biggest servers on the network and running Soapbox and people don't even know it!

License & Credits

Soapbox is based on Gab Social's frontend which is in turn based on Mastodon's frontend.

  • app/assets/sounds/chat.mp3 and app/assets/sounds/chat.oga are from notificationsounds.com, licensed under CC BY 4.0.
  • soapbox-screenshot.png was created using Vectary 3D with assets licensed under CC0. The resulting file is licensed under CC BY 4.0.

Soapbox is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Soapbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with Soapbox. If not, see https://www.gnu.org/licenses/.