ZDDC/browse/README.md
2026-06-11 13:32:31 -05:00

53 lines
2.2 KiB
Markdown

# browse — directory listing tool
Generic file browser for any directory. Designed to work with ZDDC
archives but useful for any folder. Single-file HTML, no install.
## How it's used
Two modes, auto-detected at page load:
1. **Online (zddc-server backed).** When this HTML is served by
zddc-server at a folder URL — which it is by default for any
directory under `ZDDC_ROOT` that doesn't have an `index.html`
the JS queries the same URL with `Accept: application/json` to
load the directory's listing and renders it as a sortable,
filterable table.
2. **Local (FileSystemAccessAPI).** Click "Select Directory" in the
header to pick any folder on your computer. Works in
Chromium-based browsers (Chrome, Edge, Brave, etc.). No server
required; the directory is read directly from disk.
## What it does
- Lists files and folders with name, size, type (extension), and
modified date.
- Click a folder to expand inline. Children load lazily on first
expand.
- Click a column header to sort by that column. Click again to
reverse.
- Type in the filter to narrow to entries whose name contains the
substring.
- Click any file to open it in a new tab — for server-backed pages,
this routes through zddc-server's normal handler (so an `.archive`
redirect, an apps cascade override, etc. all work as expected).
## Design notes
- **No ZDDC-specific filtering.** This tool is intentionally
domain-agnostic. The companion `archive` tool layers ZDDC
parsing (project / status / revision filters, tracking-number
resolution) on top of the same listing API. Use `archive` when
you want ZDDC semantics; use `browse` when you just want to see
what's in a folder.
- **Default at directory URLs.** zddc-server's `directory.go`
serves the embedded browse.html bytes for any directory request
with `Accept: text/html` and no `index.html` present. This
means a user navigating to any folder under `ZDDC_ROOT` gets a
usable browser without anyone having to drop a file into the
archive.
- **Apps cascade override.** Like every other ZDDC tool, the
served `browse.html` can be overridden per-folder via a `.zddc
apps:` entry. The default is the embedded copy from the binary;
operators can pin a specific version or URL if they want.