Install Tooling
Objective
Install the necessary tooling to begin working with the Panfactum stack.
Supported Systems
- Linux
- macOS (Intel or ARM,
Sonomaor later) - Windows (via
WSLv2)
Installation
Please install these tools:
| Tool | Version | Purpose | Installation Docs |
|---|---|---|---|
git | ~>2.40 | Primary version control tool | Docs |
git-lfs | ~>3.4 | Git extension for working with large binary blobs | Docs |
git-credential-manager | ~>2.4 | (Optional) Helper for securely caching HTTPS credentials for private git repositories. | Docs |
nix | ~>2.23 | Package management tool used to install all other dependencies | Docs |
direnv | ~>2.32 | Automatically loads tooling when entering the project directory | Docs |
Note that you should install nix using the Determinate Systems installer. This is NOT the installer found on the NixOS website.
If you choose not use this installer, you will need to ensure that you complete these extra setup steps manually in order to enable functionality such as Nix flakes.
Installation Notes
-
Make sure that you hook
direnvinto your shell via these instructions. -
If you are using an earlier version of macOS, you may run into this issue where the
nixbinary cannot be found. Addexport PATH="$NIX_LINK/bin:/nix/var/nix/profiles/default/bin:$PATHto your~/.zshrcto resolve the issue.