Merge remote-tracking branch 'upstream/master' into main

Author: ThomasFarstrike

.gitignore

@@ -0,0 +1,102 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+.DS_Store
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Webpack
+.webpack/
+.webpack_*
+
+# Vite
+.vite/
+
+# Electron-Forge
+out/
+
+# electron-builder
+dist/
+
+# external resources
+vnc-software/tigervnc-linux-x86_64
+
+# trashcan
+trash/

README.md

@@ -25,3 +25,43 @@ Here's a list of some key, free and open-source technologies that make this poss
 - LNBits, for quickly building reusable payment QR codes using the LNURLp standard.
 - Electron, for building standalone applications using open web standards.
 - Bitcoin and Lightning, for accepting payments without needing anyone's permission or approval.
+
+# Development
+
+## Install dependencies
+
+To install the dependencies from package.json using the specific version from package-lock.json, run:
+
+`npm install`
+
+## Download and extract TigerVNC
+
+Before starting the app, first make sure you have downloaded and extracted the TigerVNC software:
+
+`./vnc-software/download_tigervnc.sh`
+
+## Start the app
+
+To start the PeerViewer standalone Electron app, do:
+
+`npm run # which runs the "start" script from package.json`
+
+You can enable Chrome Developer Tools by setting "devTools: true" in src/main.js and then pressing CTRL-SHIFT-i in the app.
+
+## Build a release
+
+To build a release, have a look at the interactive script:
+
+`./release.sh`
+
+## Run as webapp
+
+To run it as a webapp on http://localhost:8000/, do:
+
+`./serve_dev_website.sh`
+
+Note that HolePunch and the VNC client and server binaries don't work in the webapp.
+
+To get this working in a webbrowser as a webapp, it should be possible to integrate https://novnc.com/ as the VNC Client and use the HolePunch DHT websocket relay for connections.
+For the server-side, it might be possible to build a browser-based VNC server using https://developer.mozilla.org/en-US/docs/Web/API/Screen_Capture_API/
+

build.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+
+# If you run it in dev mode first with:
+# npm run start
+# Then the app tries to connect to localhost:3000 instead of packaging the actual files when building with:
+#./node_modules/.bin/electron-builder
+
+# Therefore, first make sure the correct files are packaged with electron-forge like:
+./node_modules/.bin/electron-forge package
+
+export DEBUG=electron-builder
+./node_modules/.bin/electron-builder -l appimage
+
+# build more:
+#./node_modules/.bin/electron-builder -l appimage zip deb snap rpm
+
+# NOTE: Don't use prepackage because the electron-builder will not add the tigervnc/ folder:
+#./node_modules/.bin/electron-builder --prepackaged  out/peerviewer-linux-x64/ -l appimage
+

build/icons/512x512.png

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+sources=src
+
+for tocopy in index.css index.html images/ ; do
+	cp -R "$sources"/"$tocopy" ../website/
+done

copy_http.sh

@@ -0,0 +1,15 @@
+appId: "com.peerviewer.app"
+linux: { "category": "Network" }
+# only include .webpack, as that's enough:
+"files": [
+           ".webpack/**/*"
+	]
+# these are added to the package:
+"extraResources": [
+      {
+        "from": "vnc-software",
+        "to": "vnc-software",
+        "filter": ["**/*"]
+      }
+    ]
+

electron-builder.yml

@@ -0,0 +1,50 @@
+module.exports = {
+  packagerConfig: {
+    asar: true,
+  },
+  rebuildConfig: {},
+  makers: [
+    {
+      name: '@electron-forge/maker-squirrel',
+      config: {},
+    },
+    {
+      name: '@electron-forge/maker-zip',
+      platforms: ['linux'],
+    },
+    {
+      name: '@electron-forge/maker-deb',
+      config: {
+	options: {
+          maintainer: 'Thomas Farstrike',
+          homepage: 'https://peerviewer.github.io/'
+        }
+      },
+    },
+  ],
+  plugins: [
+    {
+      name: '@electron-forge/plugin-auto-unpack-natives',
+      config: {},
+    },
+    {
+      name: '@electron-forge/plugin-webpack',
+      config: {
+        mainConfig: './webpack.main.config.js',
+        renderer: {
+          config: './webpack.renderer.config.js',
+          entryPoints: [
+            {
+              html: './src/index.html',
+              js: './src/renderer.js',
+              name: 'main_window',
+              preload: {
+                js: './src/preload.js',
+              },
+            },
+          ],
+        },
+      },
+    },
+  ],
+};