making master the webextension again.

Author: soapdog

.eslintrc.json

@@ -2,7 +2,8 @@
     "env": {
         "browser": true,
         "commonjs": true,
-        "es6": true
+        "es6": true,
+        "webextensions": true
     },
     "globals": {
         "hermiebox": true,
@@ -13,15 +14,20 @@
         "process": true,
         "history": true,
         "location": true,
-        "setServerType": true,
-        "__dirname": true
+        "setServerType": true
     },
     "extends": "eslint:recommended",
     "parserOptions": {
         "ecmaVersion": 2020,
         "sourceType": "module"
     },
-    "plugins": [],
+    "plugins": ["svelte3"],
+    "overrides": [
+        {
+            "files": ["*.svelte"],
+            "processor": "svelte3/svelte3"
+        }
+    ],
     "rules": {
         "indent": ["error", 2],
         "linebreak-style": ["error", "unix"],

.gitignore

@@ -5,18 +5,13 @@ node_modules
 web-ext-artifacts
 *.zip
 old-src
-build
 
 \#*
 .vscode
 test/
 old/
-desktop-old/
 
 *.sublime-workspace
 .vscode
-reference-*
 
-*.tgz
-
-TODO.md
+reference-material*

.jshintrc

@@ -3,7 +3,7 @@
   "quotmark": "double",
   "camelcase": true,
   "browser": true,
-  "semi": false,
+  "asi": true,
   "globals": {
   	"Dexie": true,
   	"_": true

README.md

@@ -1,44 +1,48 @@
 # Patchfox
+This is a new client for [Secure Scuttlebutt](http://scuttlebutt.nz) packaged as a Web Extension. This is a new client for [Secure Scuttlebutt](http://scuttlebutt.nz) packaged as a Web Extension for Firefox. It is available on:
 
-[![Build/release](https://github.com/soapdog/patchfox/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/soapdog/patchfox/actions/workflows/build.yml)
+* [Firefox Add-ons Portal](https://addons.mozilla.org/en-US/firefox/addon/patchfox/)
+* [Chrome Web Store](https://chrome.google.com/webstore/detail/patchfox/ocanekmedfooidiahhelofknmpobdmdp?hl=en-GB&authuser=0)
 
-This is a client for [Secure Scuttlebutt](http://scuttlebutt.nz). It is available on:
+So if you just want to run it, that's the easiest way. Read on if you want to develop with it. Read on if you want to develop with it.
 
-* [Patchfox website](https://patchfox.org)
-* [Github release pages](https://github.com/soapdog/patchfox/releases)
+## Requirements
 
-## Patchfox has a rich set of documentation
+* [Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) or [Firefox Nightly](https://www.mozilla.org/en-US/firefox/nightly/) (needed so that you can sideload unsigned add-ons)
+* [Scuttle Shell](https://github.com/ssbc/scuttle-shell). This is a soft requirement. You can use your own _sbot_ or even have another client such as [Patchwork](http://github.com/ssbc/patchwork) or [Patchbay](http://github.com/ssbc/patchbay) running and providing a running _sbot_. 
 
-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:
+Patchfox uses [Svelte](https://svelte.technology) 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:
+And build the add-on with:
 
 ```
-$ npm run start
+$ npm run clean-build
 ```
 
-To build use:
+If you use:
 
 ```
-$ npm run build
+$ npm run clean-dev
 ```
 
+It will build the add-on using sourcemaps which makes debugging easier but can't be submit to AMO because they limit bundles to 4mb.
+
+## Running
+
+Go to [about:debugging](about:debugging) on Firefox, select `this firefox` and click to add a temporary add-on. Select the `manifest.json` file from the `dist/` folder from this repository.
 
 ## 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.
+Once patchfox is running, it needs to learn your _remote_ and _secret_, you can just click the "browse" button on the setup screen and select your `.ssb/secret` file. Patchfox will use the data inside your secret file to derive your remote address. Remember to click save. 
+
+After saving Patchfox will then try loading your public feed. You need to have a running _sbot_ for it to work.
 
 # Testing the protocol schemas
 
@@ -50,6 +54,9 @@ After installing and configuring patchfox, try browsing to:
 
 If you're interested in learning more about the technologies behind this add-on, check out:
 
+* [MDN Web Docs - WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/).
+* [Native Messaging API](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging)
+* [Native Messaging setup](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging#Setup)
 * [Secure Scuttlebutt Protocol Guide](https://ssbc.github.io/scuttlebutt-protocol-guide/)
 
 Don't hesitate to reach out to me at:
@@ -62,9 +69,9 @@ Don't hesitate to reach out to me at:
 
 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:
@@ -75,6 +82,12 @@ Patchfox is using artwork by many artists including:
 
 * Artwork for the 2020.2.1 release poster was done by: Photo by Krista Stucchio on Unsplash
 
+# Third party vendored libraries
+
+* Keymage 1.1.3: http://github.com/piranha/keymage
+* ssb-custom-uri: https://git.sr.ht/~soapdog/ssb-custom-uri
+* browser-polyfill: https://github.com/mozilla/webextension-polyfill
+
 # Dependencies Licenses
 
 Check [licenses.html](licenses.html)

ROADMAP.md

@@ -0,0 +1,25 @@
+# ROADMAP
+
+More like _small trail guide_ than an actual _roadmap_. This document is used to hold stuff that I want to check out for the next version. I have ideas for Patchfox during my daily life, and if I don't write it down, I forget them and they're never implemented or fixed.
+
+- Books
+    - Bug: `images` might be an `Object` instead of an `Array`. The _details view_ already take that into account but the _list view_ doesn't.
+    - Feature: add support for comments to books and reviews.
+    - Feature: check if importer from goodreads and the storygraph is possible.
+- Calendar
+    - Bug: missing gatherings on _future events_ feature. I guess it is a bug with the validator.
+- Chess
+    - Investigate if it is possible to use ssb-chess or even that mithril based client, without using ssb-chess-db.
+- Inbox
+    - Create new inbox app to deal with private messages.
+- Documentation
+    - Document keyboard shortcuts.
+    - Add small user guide.
+- Settings
+    - Refactor the _filtering by message type_. Remove the reliance on _core message types_ and instead reuse the info from the package system to extrapolate messages. This is a major refactors, it affects both `ssb.js` and the settings package.
+- General
+    - History management has a quirk where going to a package sometimes enter the data twice into history, or going back doesn't actually go back but reloads the same package. This has been a tricky bug since the start of Patchfox. Symptom is requiring you to click back multiple times before you're actually on the previous package/view combo. Might need a major refactoring.
+    - Add support for the new `ssb-uri` from Staltz.
+- Licenses report
+    - Decide between "license-checker" and "license-report".
+    - Use one of them to generate a license report for all direct dependencies, and add them to the documentation.