https://github.com/ggorg0/yew-nix-docker-template
A basic Yew.rs project, with Nix and Docker integration
https://github.com/ggorg0/yew-nix-docker-template
Last synced: 3 months ago
JSON representation
A basic Yew.rs project, with Nix and Docker integration
- Host: GitHub
- URL: https://github.com/ggorg0/yew-nix-docker-template
- Owner: GGORG0
- License: mit
- Created: 2024-08-15T09:34:35.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-08-16T18:52:10.000Z (9 months ago)
- Last Synced: 2025-01-17T00:35:43.027Z (4 months ago)
- Language: Nix
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yew.rs + Nix + Docker template
A basic Yew.rs project, with Nix and Docker integration
## Usage
Change the project name in `Cargo.toml`, and the description in `flake.nix`.
```sh
trunk serve --open # start a development server at 127.0.0.1:8080 with auto reloading and open it in your browser
trunk build --release # build the project into the `dist/` directory
# NOTE:
cargo run # will panic, use the `trunk` CLI
```
If you aren't using the Nix dev shell, you might need to:
- Add the `wasm32-unknown-unknown` Rust target: `rustup target add wasm32-unknown-unknown`
- [Install Trunk](https://trunkrs.dev/#install)
## Nix
This project contains a Nix flake, with Crane to build the Rust project.
It is based on [this example](https://crane.dev/examples/trunk-workspace.html).
It builds the project and exposes HTML + CSS + JS + WASM files in the output package.
It also contains a development shell with all needed packages.
When running `nix run` it will build the package and serve it with darkhttpd on `0.0.0.0:8080`.
## Docker
This project contains a `Dockerfile`, and a `compose.yaml` file.
The `Dockerfile` builds the project (with layer caching support) and copies the output files to a basic Nginx container.
The `compose.yaml` file builds the image and exposes the website at `0.0.0.0:8080`.
## GitHub Actions and Pages
This project contains a GitHub Actions workflow.
It builds the project using Nix and publishes the output files as a build artifact.
It also deploys them to GitHub Pages.
**NOTE:** If you are deploying this under a subpath (e.g. `https://user.github.io/repo/` instead of `https://user.github.io/`), you will need to set the `build.public_url` value in `Trunk.toml` to your path (e.g. `/repo/`) or the entire URL (e.g. `https://user.github.io/repo/`). If you are using a custom domain or deploying it on the root of your github.io domain, you don't need to do anything.
## License
You can base your project on this template. It is licensed under the MIT (see `LICENSE`).