dev-templates/README.md
2022-07-31 17:05:20 +02:00

3.2 KiB

Nix flake templates for easy dev environments

To initialize (where ${ENV} is listed in the table below):

nix flake init --template github:the-nix-way/dev-templates#${ENV}

Here's an example (for the rust template):

# Initialize in the current project
nix flake init --template github:the-nix-way/dev-templates#rust

# Create a new project
nix flake new --template github:the-nix-way/dev-templates#rust ${NEW_PROJECT_DIRECTORY}

How to use the templates

Once your preferred template has been initialized, you can use the provided shell in two ways:

  1. If you have nix-direnv installed, you can initialize the environment by running direnv allow.
  2. If you don't have nix-direnv installed, you can run nix develop to open up the Nix-defined shell.

Available templates

Language/framework/tool Template
Dhall dhall
Elixir elixir
Gleam gleam
Go 1.17 go1_17
Go 1.18 go1_18
Java java
Kotlin kotlin
Nix nix
Node.js node
Protobuf protobuf
Rust rust
Scala scala
Zig zig

Template contents

The sections below list what each template includes.

dhall