This repository contains a list of project templates to be used with the nix flake init command.
If you like any of the templates in this repository, you can easily start a new project from them with the one of the following commands:
# Initialize in the current directory
nix flake init --template github:sagikazarmark/nix-templates#TEMPLATE
# Create a new directory
nix flake new --template github:sagikazarmark/nix-templates#TEMPLATE NEW_PROJECT| Template | Description |
|---|---|
| base | A basic project template |
| base-dev | A basic project template targeted at development |
| base-kube | A basic project template with Kubernetes tools |
| go-library | A Go library template |
| go-service | A Go service template |
| go-simple-cli | A simple Go CLI template |
Use the base template to scaffold a new template:
nix flake new --template .#base NEW_TEMPLATEAdd the template to the list above.
Some of the components need updating from time to time. This section describes the steps to do that.
All templates come with a nix-direnv initialization in .envrc to make sure the generated projects are self-contained.
This makes projects usable without installing nix-direnv on the machine manually.
The nix-direnv version in .envrc is pinned, so it needs updating from time to time.
Run the following command to update nix-direnv to a specific version:
update-envrc 2.1.2Review the changes then commit, push and open a PR.
Check out the Official Nix templates for more examples.
Kudos to @lucperkins for creating The Nix Way. These template are inspired by his dev templates.
The project is licensed under the MIT License.