Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soapdog/patchfox
A client for scuttlebutt network as a Firefox WebExtension
https://github.com/soapdog/patchfox
firefox-webextension nodejs scuttlebutt webextensions
Last synced: 19 days ago
JSON representation
A client for scuttlebutt network as a Firefox WebExtension
- Host: GitHub
- URL: https://github.com/soapdog/patchfox
- Owner: soapdog
- License: mit
- Created: 2018-01-15T18:01:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T18:57:47.000Z (over 1 year ago)
- Last Synced: 2024-05-23T01:21:56.787Z (6 months ago)
- Topics: firefox-webextension, nodejs, scuttlebutt, webextensions
- Language: JavaScript
- Size: 206 MB
- Stars: 168
- Watchers: 11
- Forks: 28
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Patchfox
[](https://github.com/soapdog/patchfox/actions/workflows/build.yml)
This is a client for [Secure Scuttlebutt](http://scuttlebutt.nz). It is available on:
* [Patchfox website](https://patchfox.org)
* [Github release pages](https://github.com/soapdog/patchfox/releases)
## Patchfox has a rich set of documentation
Head over to the [Patchfox website](https://patchfox.org) for the documentation.
## Requirements for development
* [NodeJS](https://nodejs.org)
## Setup & Building
Patchfox uses [Mithril](https://mithril.js.org), [Electron](https://electronjs.org) and requires [NodeJS](https://nodejs.org) for development. After you have NodeJS installed, you can install the dependencies with:
```
$ npm install
```
And run a development version of the app using:
```
$ npm run start
```
To build use:
```
$ npm run build
```
## Setup inside Patchfox
Patchfox will use your default SSB data folder if available (the `.ssb` folder inside your home folder). If this is your first time using SSB, Patchfox will create that folder for you and place new keys inside.
# Testing the protocol schemas
After installing and configuring patchfox, try browsing to:
[ssb://message/sha256/Acm4sCjCDGWADCw773gfQyQ03tVYmxQLhyUWET8wLPc%3D](ssb://message/sha256/Acm4sCjCDGWADCw773gfQyQ03tVYmxQLhyUWET8wLPc%3D)
# Commentary, getting help
If you're interested in learning more about the technologies behind this add-on, check out:
* [Secure Scuttlebutt Protocol Guide](https://ssbc.github.io/scuttlebutt-protocol-guide/)
Don't hesitate to reach out to me at:
* Scuttlebutt: `@gaQw6z30GpfsW9k8V5ED4pHrg8zmrqku24zTSAINhRg=.ed25519`
* Mastodon: [@[email protected]](https://toot.cafe/@soapdog)
* Twitter: [@soapdog](http://twitter.com/soapdog/)
# Sponsorship
Do you want a decentralized internet too? Are you worried about the loss of net neutrality and realized that radical decentralization is the way to fight back? If you want to make a financial contribution to help me fund development of this and other dex focused software, I would love to receive contributions through these channels:
* [Buy Me A Coffee (preferred)](https://ko-fi.com/andreshouldbewriting)
* [Patchfox Open Collective](https://opencollective.com/patchfox)
# Artwork attribution
Patchfox is using artwork by many artists including:
* Art made by Angelica.
* Some icons made by Eucalyp from www.flaticon.com.
* Artwork for the 2020.2.1 release poster was done by: Photo by Krista Stucchio on Unsplash
# Dependencies Licenses
Check [licenses.html](licenses.html)