chore(treewide): Add flake and README

5 files changed, 111 insertions, 56 deletions

diff --git a/.envrc b/.envrc
new file mode 100644
index 00000000..3550a30f
--- /dev/null
+++ b/.envrc
@@ -0,0 +1 @@
+use flake
diff --git a/.gitignore b/.gitignore
index 44170d13..b975c4b8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,9 @@
+# build dirs
 web-ext-artifacts/
+/.direnv
+/result
+
+# other things
 .DS_Store
 nod
 node_modules
diff --git a/README.md b/README.md
index e8a1f2dc..8f201dd6 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1,3 @@
-<img src="./img/libredirect_full.svg" height="50"/>
-
-A browser extension that redirects YouTube, Twitter, TikTok... requests to alternative privacy friendly frontends and backends.
-
-<a href="https://addons.mozilla.org/firefox/addon/libredirect/">
-    <img src ="./img/badge-amo.png" height=60 >
-</a>
-&nbsp;
-<a href="https://libredirect.github.io/download_chromium.html">
-    <img src ="./img/badge-chromium.png" height=60 >
-</a>
-
-## Translate
-<a href="https://hosted.weblate.org/projects/libredirect/extension">
-    <img src ="./img/weblate.svg">
-</a>
-
-## Development
-Install [Node.js](https://nodejs.org/)
-```bash
-git clone https://github.com/libredirect/browser_extension
-cd browser_extension
-npm install
-npm run html # Generates html using Pug
-```
-#### Run on Firefox
-```bash
-npm run start
-```
-
-#### Build a zip package for Firefox
-```bash
-npm run build
-```
-
-#### Install the zip package on Firefox (temporarily)
-1. Type in the address bar: `about:debugging#/runtime/this-firefox`
-2. Press `Load Temporary Add-on...`
-3. Select `libredirect-VERSION.zip` from `web-ext-artifacts` folder
-
-#### Install the zip package on Firefox ESR, Developer Edition, Nightly
-1. Type in the address bar: `about:config`
-2. Set `xpinstall.signatures.required` to `false`
-3. Type in the address bar: `about:addons`
-4. Click on the gear shaped `settings` button and select `Install Add-on From File...`
-5. Select `libredirect-VERSION.zip` from `web-ext-artifacts` folder
-
-#### Run on Chromium
-1. Open `chrome://extensions`
-2. Enable `dev mode`
-3. Select `load unpacked extension`
-4. Select `src` folder
-
----
-
-Forked from [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect)
+# LibRedirect fork for vhack.eu services
+This is a soft fork of [LibRedirect](https://codeberg.org/LibRedirect/browser_extension)
+with the vhack.eu services pre-configured.
diff --git a/flake.lock b/flake.lock
new file mode 100644
index 00000000..94e4d2d9
--- /dev/null
+++ b/flake.lock
@@ -0,0 +1,64 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": [
+          "systems"
+        ]
+      },
+      "locked": {
+        "lastModified": 1694529238,
+        "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "ff7b65b44d01cf9ba6a71320833626af21126384",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1685566663,
+        "narHash": "sha256-btHN1czJ6rzteeCuE/PNrdssqYD2nIA4w48miQAFloM=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "4ecab3273592f27479a583fb6d975d4aba3486fe",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "23.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs",
+        "systems": "systems"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1680978846,
+        "narHash": "sha256-Gtqg8b/v49BFDpDetjclCYXm8mAnTrUzR0JnE2nv5aw=",
+        "owner": "nix-systems",
+        "repo": "x86_64-linux",
+        "rev": "2ecfcac5e15790ba6ce360ceccddb15ad16d08a8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "x86_64-linux",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}
diff --git a/flake.nix b/flake.nix
new file mode 100644
index 00000000..5aa629f6
--- /dev/null
+++ b/flake.nix
@@ -0,0 +1,38 @@
+{
+  description = "vhack.eu's soft fork of LibRedirect";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/23.05";
+
+    # inputs for following
+    systems = {
+      url = "github:nix-systems/x86_64-linux"; # only evaluate for this system
+    };
+    flake-utils = {
+      url = "github:numtide/flake-utils";
+      inputs = {
+        systems.follows = "systems";
+      };
+    };
+  };
+
+  outputs = {
+    nixpkgs,
+    flake-utils,
+    ...
+  }:
+    flake-utils.lib.eachDefaultSystem (system: let
+      pkgs = nixpkgs.legacyPackages."${system}";
+
+    in {
+      devShells.default = pkgs.mkShell {
+        packages = [
+          pkgs.nodejs
+          pkgs.nodePackages_latest.web-ext
+          pkgs.nodePackages_latest.prettier
+        ];
+      };
+    });
+}
+# vim: ts=2
+