Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sambacha/nix-template

template for dapptools/nix
https://github.com/sambacha/nix-template

boilerplate dapphub dapptools ethereum nix nixos template tutorial

Last synced: 24 days ago
JSON representation

template for dapptools/nix

Host: GitHub
URL: https://github.com/sambacha/nix-template
Owner: sambacha
Created: 2021-02-28T19:20:52.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2023-03-02T00:57:34.000Z (over 1 year ago)
Last Synced: 2024-10-06T15:42:01.032Z (about 1 month ago)
Topics: boilerplate, dapphub, dapptools, ethereum, nix, nixos, template, tutorial
Language: Nix
Homepage:
Size: 31.3 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # [Nix](#) 

> Opinionated repository template

[![Nix: Coverage](https://github.com/sambacha/nix-template/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/sambacha/nix-template/actions/workflows/test.yml) [![niv auto update](https://github.com/sambacha/nix-template/actions/workflows/update-niv.yml/badge.svg?branch=master)](https://github.com/sambacha/nix-template/actions/workflows/update-niv.yml)

```bash

wget https://github.com/sambacha/nix-template/archive/master.zip

```

Based on [nix.dev](https://nix.dev) tutorials, repository template to get you started with [Nix](https://nixos.org/):

- [niv](https://github.com/nmattia/niv) for painless dependency management (aka pinning) with a daily cronjob to bump dependencies

- [gitignore.nix](https://github.com/hercules-ci/gitignore.nix) for respecting `.gitignore` when using your project as a source

- [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix) for running linters (defaults to `shellcheck`, `nix-linter` and `nixpkgs-fmt`) when committing and on the CI

- [direnv](https://direnv.net/) for automatically loading your developer environment

- [GitHub Actions](https://github.com/features/actions) for CI with [dependabot](https://dependabot.com/) automatically bumping GitHub Actions versions

## Getting started

1. Follow tutorial for [creating a binary cache](https://nix.dev/tutorials/continuous-integration-github-actions.html)

2. Replace ``nix-getting-started-template`` in ``.github/workflows/test.yml`` with the name of your binary cache

## Using the project

Follow [direnv setup](https://nix.dev/tutorials/declarative-and-reproducible-developer-environments.html#direnv-automatically-activating-the-environment-on-directory-change) and run `direnv allow`

## CI: Using Cacheix 

```yml

# Cachix Workflow

name: "cachix"

on:

  pull_request:

  push:

jobs:

  tests:

    runs-on: ubuntu-latest

    steps:

    - uses: cachix/install-nix-action@v12

    - uses: cachix/cachix-action@v8

      with:

        name: nix-getting-started-template

        signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'

        # Only needed for private caches

        #authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'

    - run: nix-build https://github.com/$GITHUB_REPOSITORY/archive/$GITHUB_SHA.tar.gz

    - run: nix-shell https://github.com/$GITHUB_REPOSITORY/archive/$GITHUB_SHA.tar.gz --run "echo OK"

```