flake.nix

#
# Nix flake for the 4DGB Browser
#
# This provides a development environment with
# necessary dependencies installed and exports several packages
# related to running the browser and preparing data.
#
# The development environment provides:
#   - python3 with required packages installed
#   - NodeJS and a NODE_PATH set to a node_modules folder
#       with required packages installed
#   - Other tools (node2nix, just, etc)
#
# The packages exported by this flake include:
#   - db_pop: Executable of the db_pop script
#   - gtk-js: Minified GTK Javascript library
#   - gtkserver: Executable of GTK Flask server
#
# (The GTK client python library is currently not included)
#
# NOTE:
#   NodeJS dependencies are generated using node2nix. If you make any changes
#   to the package.json file, you need to run node2nix again to re-create the
#   necessary files. A recipe is included to do this. Just run
#     'just rebuild-node2nix`
#   to rebuild the node2nix files, then exit and re-enter the development
#   shell.
#
#   Also, webpack is available in the development environment, but it doesn't
#   work without an actual ./node_modules directory. After entering the development
#   environment, you should create a symlink to it by running:
#     'ln -s $NODE_PATH ./node_modules'
#   Just remember to remove it when you're done!
#
{
  description = "4D Genome Browser";

  inputs = {
    # Nixpkgs
    nixpkgs.url = "github:NixOS/nixpkgs/release-22.05";

    # Flake-compat library
    # (Used to generate a flake-less nix.shell file)
    flake-compat = {
      url = "github:edolstra/flake-compat";
      flake = false;
    };

    # Flake-utils library
    flake-utils.url = "github:numtide/flake-utils";
  };

  outputs = { self, nixpkgs, flake-compat, flake-utils }:
    flake-utils.lib.eachDefaultSystem (system:
      let
        pkgs = nixpkgs.legacyPackages.${system};
        myPkgs = import ./pkgs.nix { inherit pkgs; };
      in 
      rec {
        # Export packages
        packages = { inherit (myPkgs) gtkserver db_pop gtk-js; };
        defaultPackage = packages.gtkserver;

        # Development environment
        devShell = myPkgs.devShell;
      }
    );
}