Initial commit

Author: Plopmenz

.gitignore

@@ -0,0 +1 @@
+result

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Openmesh Network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,31 @@
+## Xnode Node.js Template
+
+Template to make your Node.js app Xnode/Nix compatible.
+
+## Modification Steps
+
+1. Replace all instances of "xnode-nodejs-template" with the name of your project. This should be unique, as no apps with the same name can be run on a single Xnode.
+2. Build your Node.js app
+3. Once your app is ready for deployment and runs using `nix run`, push to GitHub and copy your GitHub url (e.g. https://github.com/Openmesh-Network/xnode-nodejs-template).
+4. Go the the App Store in [Xnode Studio](https://www.openmesh.network/xnode/app-store) and go to the advanced tab.
+5. Paste your GitHub url and enter the name of the project you choose during step 1.
+6. Hit deploy and wait for your app to be ready.
+7. Copy the deploy link and replace the one click deployment url in the next section. (to allow others to easily deploy your application)
+
+## One click deployment
+
+[<img src="https://www.openmesh.network/xnode/deploy-on-xnode.svg" width=200 />](https://www.openmesh.network/xnode/deploy?advanced=eyJkYXRhIjp7Im5hbWUiOiJ4bm9kZS1ub2RlanMtdGVtcGxhdGUiLCJkZXNjIjoiQ3VzdG9tIEFwcCIsIm5peE5hbWUiOiJ4bm9kZS1ub2RlanMtdGVtcGxhdGUiLCJvcHRpb25zIjpbeyJuYW1lIjoiZW5hYmxlIiwiZGVzYyI6IkVuYWJsZSB0aGUgbmV4dGpzIGFwcCIsIm5peE5hbWUiOiJlbmFibGUiLCJ0eXBlIjoiYm9vbGVhbiIsInZhbHVlIjoidHJ1ZSJ9LHsibmFtZSI6Imhvc3RuYW1lIiwiZGVzYyI6IlRoZSBob3N0bmFtZSB1bmRlciB3aGljaCB0aGUgYXBwIHNob3VsZCBiZSBhY2Nlc3NpYmxlLiIsIm5peE5hbWUiOiJob3N0bmFtZSIsInR5cGUiOiJzdHJpbmciLCJ2YWx1ZSI6IjAuMC4wLjAifSx7Im5hbWUiOiJwb3J0IiwiZGVzYyI6IlRoZSBwb3J0IHVuZGVyIHdoaWNoIHRoZSBhcHAgc2hvdWxkIGJlIGFjY2Vzc2libGUuIiwibml4TmFtZSI6InBvcnQiLCJ0eXBlIjoiMTYgYml0IHVuc2lnbmVkIGludGVnZXI7IGJldHdlZW4gMCBhbmQgNjU1MzUgKGJvdGggaW5jbHVzaXZlKSIsInZhbHVlIjoiMzAwMCJ9LHsibmFtZSI6Im9wZW5GaXJld2FsbCIsImRlc2MiOiJXaGV0aGVyIHRvIG9wZW4gcG9ydHMgaW4gdGhlIGZpcmV3YWxsIGZvciB0aGlzIGFwcGxpY2F0aW9uLiIsIm5peE5hbWUiOiJvcGVuRmlyZXdhbGwiLCJ0eXBlIjoiYm9vbGVhbiIsInZhbHVlIjoidHJ1ZSJ9XSwidGFncyI6W10sImZsYWtlcyI6W3sibmFtZSI6Inhub2RlLW5vZGVqcy10ZW1wbGF0ZS1mbGFrZSIsInVybCI6ImdpdGh1YjpPcGVubWVzaC1OZXR3b3JrL3hub2RlLW5vZGVqcy10ZW1wbGF0ZSJ9XSwiaWQiOiJ4bm9kZS1ub2RlanMtdGVtcGxhdGUifSwidHlwZSI6InRlbXBsYXRlcyIsInNlcnZpY2VzIjpbeyJuYW1lIjoieG5vZGUtbm9kZWpzLXRlbXBsYXRlIiwiZGVzYyI6IkN1c3RvbSBBcHAiLCJuaXhOYW1lIjoieG5vZGUtbm9kZWpzLXRlbXBsYXRlIiwib3B0aW9ucyI6W3sibmFtZSI6ImVuYWJsZSIsImRlc2MiOiJFbmFibGUgdGhlIG5leHRqcyBhcHAiLCJuaXhOYW1lIjoiZW5hYmxlIiwidHlwZSI6ImJvb2xlYW4iLCJ2YWx1ZSI6InRydWUifSx7Im5hbWUiOiJob3N0bmFtZSIsImRlc2MiOiJUaGUgaG9zdG5hbWUgdW5kZXIgd2hpY2ggdGhlIGFwcCBzaG91bGQgYmUgYWNjZXNzaWJsZS4iLCJuaXhOYW1lIjoiaG9zdG5hbWUiLCJ0eXBlIjoic3RyaW5nIiwidmFsdWUiOiIwLjAuMC4wIn0seyJuYW1lIjoicG9ydCIsImRlc2MiOiJUaGUgcG9ydCB1bmRlciB3aGljaCB0aGUgYXBwIHNob3VsZCBiZSBhY2Nlc3NpYmxlLiIsIm5peE5hbWUiOiJwb3J0IiwidHlwZSI6IjE2IGJpdCB1bnNpZ25lZCBpbnRlZ2VyOyBiZXR3ZWVuIDAgYW5kIDY1NTM1IChib3RoIGluY2x1c2l2ZSkiLCJ2YWx1ZSI6IjMwMDAifSx7Im5hbWUiOiJvcGVuRmlyZXdhbGwiLCJkZXNjIjoiV2hldGhlciB0byBvcGVuIHBvcnRzIGluIHRoZSBmaXJld2FsbCBmb3IgdGhpcyBhcHBsaWNhdGlvbi4iLCJuaXhOYW1lIjoib3BlbkZpcmV3YWxsIiwidHlwZSI6ImJvb2xlYW4iLCJ2YWx1ZSI6InRydWUifV0sInRhZ3MiOltdLCJmbGFrZXMiOlt7Im5hbWUiOiJ4bm9kZS1ub2RlanMtdGVtcGxhdGUtZmxha2UiLCJ1cmwiOiJnaXRodWI6T3Blbm1lc2gtTmV0d29yay94bm9kZS1ub2RlanMtdGVtcGxhdGUifV19XX0=)
+
+## Commands (in root folder)
+
+```
+nix run
+```
+
+## Commands (in nodejs-app)
+
+```
+npm i
+npm run build
+npm run start
+```

example/flake.nix

@@ -0,0 +1,49 @@
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    xnode-nodejs-template.url = "github:Openmesh-Network/xnode-nodejs-template";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      xnode-nodejs-template,
+      ...
+    }:
+    let
+      system = "x86_64-linux";
+    in
+    {
+      nixosConfigurations.container = nixpkgs.lib.nixosSystem {
+        inherit system;
+        specialArgs = {
+          inherit xnode-nodejs-template;
+        };
+        modules = [
+          (
+            { xnode-nodejs-template, ... }:
+            {
+              imports = [
+                xnode-nodejs-template.nixosModules.default
+              ];
+
+              boot.isContainer = true;
+
+              services.xnode-nodejs-template = {
+                enable = true;
+              };
+
+              networking = {
+                useHostResolvConf = nixpkgs.lib.mkForce false;
+              };
+
+              services.resolved.enable = true;
+
+              system.stateVersion = "25.05";
+            }
+          )
+        ];
+      };
+    };
+}

flake.lock

@@ -0,0 +1,46 @@
+{
+  description = "Nodejs app running on Xnode!";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
+    systems.url = "github:nix-systems/default";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      systems,
+    }:
+    let
+      # A helper that helps us define the attributes below for
+      # all systems we care about.
+      eachSystem =
+        f:
+        nixpkgs.lib.genAttrs (import systems) (
+          system:
+          f {
+            inherit system;
+            pkgs = nixpkgs.legacyPackages.${system};
+          }
+        );
+    in
+    {
+      packages = eachSystem (
+        { pkgs, ... }:
+        {
+          default = pkgs.callPackage ./nix/package.nix { };
+        }
+      );
+
+      checks = eachSystem (
+        { pkgs, system, ... }:
+        {
+          package = self.packages.${system}.default;
+          nixos-module = pkgs.callPackage ./nix/nixos-test.nix { };
+        }
+      );
+
+      nixosModules.default = ./nix/nixos-module.nix;
+    };
+}

flake.nix

@@ -0,0 +1,36 @@
+{
+  config,
+  pkgs,
+  lib,
+  ...
+}:
+let
+  cfg = config.services.xnode-nodejs-template;
+  xnode-nodejs-template = pkgs.callPackage ./package.nix { };
+in
+{
+  options = {
+    services.xnode-nodejs-template = {
+      enable = lib.mkEnableOption "Enable the node.js app";
+    };
+  };
+
+  config = lib.mkIf cfg.enable {
+    users.groups.xnode-nodejs-template = { };
+    users.users.xnode-nodejs-template = {
+      isSystemUser = true;
+      group = "xnode-nodejs-template";
+    };
+
+    systemd.services.xnode-nodejs-template = {
+      wantedBy = [ "multi-user.target" ];
+      description = "Node.js App.";
+      after = [ "network.target" ];
+      serviceConfig = {
+        ExecStart = "${lib.getExe xnode-nodejs-template}";
+        User = "xnode-nodejs-template";
+        Group = "xnode-nodejs-template";
+      };
+    };
+  };
+}

nix/nixos-module.nix

@@ -0,0 +1,36 @@
+{ pkgs, lib }:
+let
+  pname = "xnode-nodejs-template";
+in
+pkgs.buildNpmPackage {
+  inherit pname;
+  version = "1.0.0";
+  src = ../nodejs-app;
+
+  npmDeps = pkgs.importNpmLock {
+    npmRoot = ../nodejs-app;
+  };
+  npmConfigHook = pkgs.importNpmLock.npmConfigHook;
+
+  postBuild = ''
+    # Add a shebang to the server js file, then patch the shebang to use a
+    # nixpkgs nodes binary
+    sed -i '1s|^|#!/usr/bin/env node\n|' build/index.js
+    patchShebangs build/index.js
+  '';
+
+  installPhase = ''
+    mkdir -p $out
+    cp package.json $out/package.json
+    cp -r node_modules $out/node_modules
+    cp -r build $out/build
+    chmod +x $out/build/index.js
+    makeWrapper $out/build/index.js $out/bin/xnode-nodejs-template 
+  '';
+
+  doDist = false;
+
+  meta = {
+    mainProgram = "xnode-nodejs-template";
+  };
+}

nix/package.nix

@@ -0,0 +1,3 @@
+node_modules
+.env
+build

nodejs-app/.gitignore

@@ -0,0 +1 @@
+console.log("Hello, world!");

nodejs-app/index.ts

@@ -0,0 +1,16 @@
+{
+  "name": "xnode-nodejs-app",
+  "version": "1.0.0",
+  "main": "index.ts",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rm -rf build && npx tsc",
+    "start": "node build/index.js"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.14.5",
+    "typescript": "^5.4.5"
+  }
+}

nodejs-app/package-lock.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "strictNullChecks": true,
+    "esModuleInterop": true,
+    "outDir": "build",
+    "skipLibCheck": true
+  },
+  "exclude": ["node_modules"]
+}