WIP: nix-browser

Getting Started

Install Nix
Setup direnv
Clone this repo, cd to it, and run direnv allow.

This will automatically activate the nix develop shell. Open VSCode and install recommended extensions, making sure direnv activates in VSCode as well.

Note

If you would like to learn the tools & technology involved in this project, follow along this README noting the places where the emoji 🎓 is used.

Running locally

In nix shell,

just watch

Nix workflows

Inside the nix develop shell (activated by direnv) you can use any of the cargo or rustc commands, as well as just workflows. Nix specific commands can also be used to work with the project:

# Full nix build
nix build

# Build and run
nix run

Contributing

When you are done with your changes, run just fmt to autoformat the source tree; the CI checks for this.
Add tests if relevant. Run just test to run the tests.
Add documentation wherever useful. To preview the docs, run just doc.

Frontend tech

Rust wasm

We use Leptos. With sufficient knowledge of Rust, you can 🎓 read the Leptos Book to get familiar with reactive frontend programming in Rust.

Styling

We use Tailwind for styling; 🎓 familiarize yourself with it! Tailwind enables developers not familiar with design to create reasonably good looking sites. You should also 🎓 get familiar with CSS flexboxes (see Flexbox Froggy).

Color palette

See tailwind.config.js for colour aliases we use throughout the app. Instead of, say, text-pink-500 we use text-primary-500 ("primary" is more semantic than "pink").

conscious-puppet / nix-browser