Development

Commands and tips for developing legit.

Issues / Tickets

See https://tangled.org/pocka.jp/legit/issues for active issues.

Load Testing

tests/k6 directory contains *.js for k6, an OSS load testing tool.

These test files access a test server on localhost:8080. Run nix run .#testing (you need Nix Flakes) or follow steps described in tests/k6/.gitignore manually (you need bash, git, and built legit binary) to launch the test server.

Once the test server is ready, pass your desired test file to k6 run command. Nix user can use nix run .#k6 -- run without installing k6 manually.

Code Formatting

This project use dprint. You have to install nixfmt and Go toolchain as well.

Nix user can run nix fmt without installing or configuring anything.

Build an OCI Image

You can build an OCI image easily with podman. legit works perfectly fine in an unprivilege (rootless) container.

On the project root directory run the following command:

podman build . -t pocka/legit

That would create and register pocka/legit image on your local registry. To test the image works, run the following command:

podman run --volume ./demo:/var/www/legit --publish 5555:5555 pocka/legit:latest

If you don't have podman on your NixOS system and quickly test these steps, use nix develop .#podman devShell. It has podman and configures minimum podman environment.