Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marijanp/nix-rust-template
A Rust project template using flake-parts, crane, fenix.
https://github.com/marijanp/nix-rust-template
axum-server flake-parts nix rust
Last synced: 15 days ago
JSON representation
A Rust project template using flake-parts, crane, fenix.
- Host: GitHub
- URL: https://github.com/marijanp/nix-rust-template
- Owner: marijanp
- License: mit
- Created: 2024-09-04T12:36:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-30T17:12:39.000Z (about 1 month ago)
- Last Synced: 2024-12-30T18:22:18.325Z (about 1 month ago)
- Topics: axum-server, flake-parts, nix, rust
- Language: Nix
- Homepage:
- Size: 78.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Rust project template packaged with Nix.
## Technologies/ Dependencies
- Rust
- axum-server
- clap
- tokio
- tracing
- Nix
- [flake-parts](https://flake.parts/)
- [crane](https://crane.dev/)
- [fenix](https://github.com/nix-community/fenix)
## Development
The following sections explain how to obtain a development shell, what tools to use during development, and lastly what to run before committing.
### Development Shell
There are two to obtain a development shell: you can configure [direnv](https://direnv.net/) to be dropped in a development shell automatically when you enter the directory (recommended) or do it manually.
#### Automatic Development Shell using `direnv`
First, you will have to [install direnv](https://direnv.net/docs/installation.html), by adding it to your Nix/NixOS configuration or using your package manager.
Afterward, add a `.envrc` file to the root of the project:
```sh
touch .envrc
echo "use flake" >> .envrc
```
Next, enable direnv for this project:
```sh
direnv allow
```
#### Obtaining a Development Shell Manually
Run:
```sh
nix develop
```
### Inside a Development Shell
Inside the development shell, you can use `cargo` as usual during development.
### Before you Commit
Because Nix gives us gives us a high degree of reproducibility, by building our project and running the checks locally and making them succeed, we can be very certain it will pass the pipeline too.
#### Build
You can explore the buildable outputs of any flake project by running:
```sh
nix flake show
```
To build e.g. `server` you can then run:
```sh
nix build .#server
```
#### Run the Checks
To run all the "checks" of this project, like formatting, lint, audit, etc. checks, run:
```sh
nix flake check
```
To run a single check e.g. the format check, run:
```sh
nix build .#checks..treefmt
```
### Format
Code for the whole project tree can be formatted by running `nix fmt` from the project's root or anywhere in the tree, but be warned that it will only format code inside the sub-tree.
The `nix fmt` command currently formats all the `Rust` and `Nix` code in the tree. To add support for more languages you'll have to adjust the `treefmt` attribute-set in the `flake.nix` accordingly. A list of already supported formatters can be found [here](https://numtide.github.io/treefmt/formatters/).