Giter VIP home page Giter VIP logo

patchwork's Introduction

Patchwork icon
Patchwork

A decentralized messaging and sharing app built on top of Secure Scuttlebutt (SSB).

Patchwork screenshot

Table of Contents
  • Features
  • Pubs
  • Install
  • Docs
  • Features

    It's better than email because:

    • Private messages are end-to-end encrypted, always.
    • You have to follow somebody to get messages from them, so you won't get spammed.
    • Your mail can be public broadcasts or private, and you'll only see replies by people you follow.
    • The datastructure is a global mesh of append-only logs, which can support new types of data (not just "mail").
    • Users are not bound to one server/host (what we call "Pubs") and do not have to trust the servers.
    • It's very easy to setup and maintain your own Pub.

    It's better than Twitter and Facebook because:

    • Private messages are end-to-end encrypted, always.
    • The software runs on your device, so there's nobody tracking your browsing.
    • The application code is FOSS, so you're free to fork or write new applications without a gatekeeper setting terms.
    • Data is saved to your disk, and so the application works offline.
    • You can sync directly with friends over Wi-Fi.

    Pubs

    In order to gossip outside your local network, you'll need to connect to a Pub.

    You can find an invite to an available pub at the Pub servers registry.

    Get an invite, then in patchwork: click "+ Join Pub" and paste the invite code.

    This will cause you to follow the Pub and vice versa. If you haven't synchronized to this social network yet, prepare to wait a few minutes while your local server synchronizes.

    Install

    Download installers for Windows, macOS and Linux

    See patchwork/releases

    Or build from source

    With node (>= 4) and npm (>= 3) installed:

    $ git clone https://github.com/ssbc/patchwork
    $ cd patchwork
    $ npm install
    $ npm start

    You'll need some more dependencies to build.

    On Debian Linux:

    sudo apt-get install g++ m4 libtool automake libgconf-2-4   # build tools
    sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev # spellchecker headers

    On Fedora Linux:

    sudo dnf install libXext-devel libXtst-devel libxkbfile-devel gcc-c++ m4 automake libtool

    On macOS:

    brew install libtool automake # build tools

    Code of conduct

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    Contributing

    Please read the Patchwork Contribution Guidelines before opening a pull request.

    Docs

    patchwork's People

    Contributors

    mmckegg avatar happy0 avatar gmarcos87 avatar alanshaw avatar mixmix avatar ahdinosaur avatar dominictarr avatar mlegore avatar cryptix avatar dangerousbeans avatar mattroseman avatar olizilla avatar mnzaki avatar pietgeursen avatar dmamills avatar ralphtheninja avatar meleyal avatar ktorn avatar olegskl avatar peterbraden avatar stackchain avatar hardfire avatar setupminimal avatar space-ed avatar federicobond avatar frafra avatar harlantwood avatar jdanford avatar jfr3000 avatar lancew avatar

    Recommend Projects

    • React photo React

      A declarative, efficient, and flexible JavaScript library for building user interfaces.

    • Vue.js photo Vue.js

      ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

    • Typescript photo Typescript

      TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

    • TensorFlow photo TensorFlow

      An Open Source Machine Learning Framework for Everyone

    • Django photo Django

      The Web framework for perfectionists with deadlines.

    • D3 photo D3

      Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

    Recommend Topics

    • javascript

      JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

    • web

      Some thing interesting about web. New door for the world.

    • server

      A server is a program made to process requests and deliver data to clients.

    • Machine learning

      Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

    • Game

      Some thing interesting about game, make everyone happy.

    Recommend Org

    • Facebook photo Facebook

      We are working to build community through open source technology. NB: members must have two-factor auth.

    • Microsoft photo Microsoft

      Open source projects and samples from Microsoft.

    • Google photo Google

      Google โค๏ธ Open Source for everyone.

    • D3 photo D3

      Data-Driven Documents codes.