homepage/README.md
2021-10-07 14:40:55 +02:00

42 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Angestöpselt Homepage
This repository contains the next version of Angestöpselt's homepage, intended
to be hosted at <angestoepselt.de>. It is built with the
[Eleventy](https://www.11ty.dev/) static site generator, using SCSS for
stylesheets.
## Local development environment
To build the site locally, make sure you have Node installed (currently tested
with version 14). Then run:
```shell
npm install
npm run build:styles
npm run dev:site
```
Go to <https://localhost:8080/>, which will update live when content changes
(the initial build may take some time to render out the different image sizes).
If you make style changes, make sure to recompile the CSS files with the second
of the above commands. Alternatively, run `npm run dev:styles` in an additional
terminal to watch for changes.
### Nix environment
This repository also contains a [Nix flake](https://nixos.wiki/wiki/Flakes)
which contains the full development environment. `nix develop` will open a
shell with all required tools you don't need to run `npm install` anymore.
Run `nix build ".#angestoepseltSiteEnv" -o .dev` to get a running Node
environment in the *.dev* folder (for example to configure an IDE).
When Node dependencies are updated (this will change `package.json`), make sure
to run `./_nix/update.sh` to update the npm lockfile and the Nix environment.
The flake also contains a second package for building the production output:
```shell
nix build # Will create an output derivation in 'result'
```
The final derivation contains a `www` folder that can be served.