/getting-started-nix-template

Based on nix.dev tutorials, repository template to get you started with Nix.

Primary LanguageNix

Opinionated Nix repository template

Based on nix.dev tutorials, repository template to get you started with Nix:

  • niv for painless dependency management (aka pinning) with a daily cronjob to bump dependencies
  • gitignore.nix for respecting .gitignore when using your project as a source
  • pre-commit-hooks.nix for running linters (defaults to shellcheck, nix-linter and nixpkgs-fmt) when committing and on the CI
  • direnv for automatically loading your developer environment
  • GitHub Actions for CI with dependabot automatically bumping GitHub Actions versions

Getting started

  1. Follow tutorial for creating a binary cache
  2. Replace nix-getting-started-template in .github/workflows/test.yml with the name of your binary cache

Using the project

Follow direnv setup and run direnv allow