Beaker 1.0 Beta

.eslintrc

@@ -23,7 +23,22 @@
   "globals": {
     "document": true,
     "navigator": true,
-    "window": true
+    "window": true,
+    "customElements": true,
+    "alert": true,
+    "uwg": true,
+    "DatArchive": true,
+    "location": true,
+    "beaker": true,
+    "prompt": true,
+    "CSSStyleSheet": true,
+    "confirm": true,
+    "fetch": true,
+    "HTMLElement": true,
+    "CustomEvent": true,
+    "localStorage": true,
+    "FileReader": true,
+    "Blob": true
   },
 
   "rules": {
@@ -88,14 +103,7 @@
     "no-label-var": "error",
     "no-labels": ["error", { "allowLoop": false, "allowSwitch": false }],
     "no-lone-blocks": "error",
-    "no-mixed-operators": ["error", {
-      "groups": [
-        ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
-        ["&&", "||"],
-        ["in", "instanceof"]
-      ],
-      "allowSamePrecedence": true
-    }],
+    "no-mixed-operators": "off",
     "no-mixed-spaces-and-tabs": "error",
     "no-multi-spaces": "off",
     "no-multi-str": "error",
@@ -127,7 +135,7 @@
     "no-throw-literal": "error",
     "no-trailing-spaces": "error",
     "no-undef": "error",
-    "no-undef-init": "error",
+    "no-undef-init": "off",
     "no-unexpected-multiline": "error",
     "no-unmodified-loop-condition": "error",
     "no-unneeded-ternary": ["off", { "defaultAssignment": false }],
@@ -140,7 +148,7 @@
     "no-useless-call": "error",
     "no-useless-computed-key": "error",
     "no-useless-constructor": "error",
-    "no-useless-escape": "error",
+    "no-useless-escape": "off",
     "no-useless-rename": "error",
     "no-useless-return": "off",
     "no-whitespace-before-property": "error",
@@ -186,6 +194,6 @@
     "standard/array-bracket-even-spacing": ["error", "either"],
     "standard/computed-property-even-spacing": ["error", "even"],
     "standard/no-callback-literal": "off",
-    "standard/object-curly-even-spacing": ["error", "either"]
+    "standard/object-curly-even-spacing": "off"
   }
 }

README.md

@@ -80,9 +80,9 @@ To build:
 
 ```bash
 git clone https://github.com/beakerbrowser/beaker.git
-cd beaker
-npm install
-npm run rebuild # see https://github.com/electron/electron/issues/5851
+cd beaker/scripts
+npm install # don't worry about v8 api errors building native modules - rebuild will fix
+npm run rebuild # needed after each install. see https://github.com/electron/electron/issues/5851
 npm start
 ```
 
@@ -93,6 +93,7 @@ npm run burnthemall
 ```
 
 This invokes [the mad king](http://nerdist.com/wp-content/uploads/2016/05/the-mad-king-game-of-thrones.jpg), who will torch your `node_modules/`, and do the full install/rebuild process for you.
+(We chose that command name when GoT was still cool.)
 `npm start` should work afterward.
 
 If you're doing development, `npm run watch` to have assets build automatically.

app/README.md

@@ -0,0 +1,7 @@
+# App
+
+- `/main.js` - Electron entrypoint
+- `/assets` - Static assets such as images, fonts, etc
+- `/bg` - Electron main process code (background)
+- `/fg` - Beaker's frontend/UI code (foreground)
+- `/userland` - Frontend code that runs in the userland environment