add nix flake

.gitignore

@@ -7,3 +7,4 @@ bench_*
 /sdk/errors_table/
 /rust-clippy-results.sarif
 /Cross.toml
+result

README.md

@@ -205,6 +205,70 @@ To see the detailed logs from the CLI/server, run it with `RUST_LOG=trace` envir
 
 ---
 
+## Nix
+
+This repo provides a [Nix](https://github.com/DeterminateSystems/nix-installer) managed development environment. To start the development shell, run:
+
+```console
+> nix develop -c $SHELL
+```
+
+This will provide you with the development environment, including the Rust toolchain and the necessary dependencies.
+
+```console
+> cargo run --bin iggy
+```
+
+The Nix flake defines derivations for the cargo workspace packages `sdk`, `cli`, `server`, `bench` & `tools`. You can build and run
+these derivations with:
+
+```console
+> nix build .#sdk
+> nix build .#cli
+> nix build .#server
+> nix build .#bench
+> nix build .#tools
+```
+
+We also export an overlay so that you can use `iggy` in your own Nix flake project:
+
+```nix
+# flake.nix
+{
+  description = "My Iggy project";
+
+  inputs.nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
+  inputs.flake-utils.url = "github:numtide/flake-utils";
+  inputs.iggy.url = "github:iggy-rs/iggy";
+
+  outputs = {
+    self,
+    nixpkgs,
+    flake-utils,
+    iggy,
+    ...
+  }: let
+    systems = ["x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin"];
+    outputs = flake-utils.lib.eachSystem systems (system: let
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [
+          iggy.overlay
+        ];
+      };
+    in {
+      devShells.default = pkgs.mkShell {
+        packages = [
+          pkgs.iggy-pkgs.cli
+          pkgs.iggy-pkgs.server
+        ];
+      };
+    });
+}
+```
+
+---
+
 ## Examples
 
 You can find the sample consumer & producer applications under `examples` directory. The purpose of these apps is to showcase the usage of the client SDK. To find out more about building the applications, please refer to the [getting started](https://docs.iggy.rs/introduction/getting-started) guide.

bench.nix

@@ -0,0 +1,68 @@
+{
+  config,
+  lib,
+  dream2nix,
+  ...
+}: {
+  imports = [
+    dream2nix.modules.dream2nix.rust-cargo-lock
+    dream2nix.modules.dream2nix.rust-crane
+  ];
+
+  deps = {nixpkgs, ...}: {
+    inherit
+      (nixpkgs)
+      stdenv
+      pkg-config
+      openssl
+      libiconv
+      darwin
+      ;
+  };
+  env = {
+    OPENSSL_NO_VENDOR = 1;
+    PKG_CONFIG_PATH = "${config.deps.openssl.dev}/lib/pkgconfig";
+  };
+  mkDerivation = {
+    src = ./.;
+
+    nativeBuildInputs = [
+      config.deps.pkg-config
+    ];
+    buildInputs =
+      [
+        config.deps.openssl
+      ]
+      ++ lib.optionals (config.deps.stdenv.isDarwin) [
+        config.deps.libiconv
+        config.deps.darwin.apple_sdk.frameworks.Security
+        config.deps.darwin.apple_sdk.frameworks.SystemConfiguration
+      ];
+  };
+
+  rust-crane = {
+    depsDrv = {
+      env = {
+        OPENSSL_NO_VENDOR = 1;
+        PKG_CONFIG_PATH = "${config.deps.openssl.dev}/lib/pkgconfig";
+      };
+      mkDerivation = {
+        nativeBuildInputs = [
+          config.deps.pkg-config
+        ];
+        buildInputs =
+          [
+            config.deps.openssl
+          ]
+          ++ lib.optionals (config.deps.stdenv.isDarwin) [
+            config.deps.libiconv
+            config.deps.darwin.apple_sdk.frameworks.Security
+            config.deps.darwin.apple_sdk.frameworks.SystemConfiguration
+          ];
+      };
+    };
+  };
+
+  name = "bench";
+  version = "0.1.0";
+}

cli.nix

@@ -0,0 +1,68 @@
+{
+  config,
+  lib,
+  dream2nix,
+  ...
+}: {
+  imports = [
+    dream2nix.modules.dream2nix.rust-cargo-lock
+    dream2nix.modules.dream2nix.rust-crane
+  ];
+
+  deps = {nixpkgs, ...}: {
+    inherit
+      (nixpkgs)
+      stdenv
+      pkg-config
+      openssl
+      libiconv
+      darwin
+      ;
+  };
+  env = {
+    OPENSSL_NO_VENDOR = 1;
+    PKG_CONFIG_PATH = "${config.deps.openssl.dev}/lib/pkgconfig";
+  };
+  mkDerivation = {
+    src = ./.;
+
+    nativeBuildInputs = [
+      config.deps.pkg-config
+    ];
+    buildInputs =
+      [
+        config.deps.openssl
+      ]
+      ++ lib.optionals (config.deps.stdenv.isDarwin) [
+        config.deps.libiconv
+        config.deps.darwin.apple_sdk.frameworks.Security
+        config.deps.darwin.apple_sdk.frameworks.SystemConfiguration
+      ];
+  };
+
+  rust-crane = {
+    depsDrv = {
+      env = {
+        OPENSSL_NO_VENDOR = 1;
+        PKG_CONFIG_PATH = "${config.deps.openssl.dev}/lib/pkgconfig";
+      };
+      mkDerivation = {
+        nativeBuildInputs = [
+          config.deps.pkg-config
+        ];
+        buildInputs =
+          [
+            config.deps.openssl
+          ]
+          ++ lib.optionals (config.deps.stdenv.isDarwin) [
+            config.deps.libiconv
+            config.deps.darwin.apple_sdk.frameworks.Security
+            config.deps.darwin.apple_sdk.frameworks.SystemConfiguration
+          ];
+      };
+    };
+  };
+
+  name = "cli";
+  version = "0.20.1";
+}