https://github.com/jakehamilton/nixpkgs.news

https://github.com/jakehamilton/nixpkgs.news

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/jakehamilton/nixpkgs.news
• Owner: jakehamilton
• Created: 2024-02-07T10:07:06.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-28T20:21:29.000Z (6 months ago)
• Last Synced: 2024-05-02T03:10:36.233Z (6 months ago)
• Language: JavaScript
• Size: 3.65 MB
• Stars: 11
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nixpkgs.news





 

> An experiment to make Nix ecosystem news more accessible.

## Development

If you are using [`direnv`](https://direnv.net), run `direnv allow` after cloning

this repository to automatically enable the development shell. If you are not

using `direnv`, then you must manually run `nix develop` in after cloning this

repository in order to activate the development shell.

The development shell provides the following packages:

- NodeJS

- Bun

Node is used for normal development tasks, but Bun is used to execute `tools/*` scripts

due to Node choking on some useful features. Ideally we would switch over to Bun fully,

but there isn't currently a Nix builder for projects using `bun.lockb` files.

To start developing, run `npm install` to get dependencies and then `npm run dev` to start

the development server.

## Usage

This project is intended to be consumed by a NixOS system. First, add this repository

as an input to your flake.

```nix

{

    description = "My Nix flake";

    inputs = {

        nixpkgs.url = "github:nixos/nixpkgs/nixos-23.11";

        nixpkgs-news = {

            url = "github:jakehamilton/nixpkgs.news";

            inputs.nixpkgs.follows = "nixpkgs";

        };

    };

}

```

Then you can serve the website's files statically using a server like nginx in your

system configuration.

```nix

{

    inputs, # Make the nixpkgs-news input available in your configuration.

    ...

}:

{

    services.nginx = {

        enable = true;

        recommendedProxySettings = true;

        virtualHosts."example.com" = {

            locations."/" = {

                root = inputs.nixpkgs-news.packages.nixpkgs-news;

            };

        };

    };

}

```