Wilnaatahl

A tool for visualizing the genealogical relationships of Gitxsan huwilp members.

Using Wilnaatahl

When you open Wilnaatahl, it boots straight into a visualization of the bundled sample dataset, so you can see what the tool does without any setup. The toolbar gives you two file actions:

Open file… — opens your operating system's file picker immediately. Pick a JSON file from your device to replace the current visualization with your own data. A file that can't be parsed leaves the current visualization in place and shows a dismissible error; a file that loads with minor issues shows a dismissible warning summary (with per-record details in the browser's dev console).
Save… — exports the currently displayed graph to a JSON file, downloaded to your browser's default download location.

Everything happens locally in your browser — files are never uploaded to a server. There is no persistence between visits: the app always starts on the sample data.

For the supported file format, see specs/json-parser.md.

Development Instructions

These instructions assume Windows 11 and PowerShell, but should be easily adaptable to other environments.

🛠️ Dev Environment Setup (Windows 11, PowerShell)

These instructions assume Git and Visual Studio Code are already installed.

✅ 1. Install Node Version Manager for Windows (nvm-windows)

Allows you to install and switch between Node.js versions easily on Windows.

Download and install the latest nvm-setup.exe from:
👉 https://github.com/coreybutler/nvm-windows/releases
Open a new PowerShell window, then install and use a stable Node.js version:

nvm install 23.11.0
nvm use 23.11.0

Verify the installation:

node -v    # Should return v23.11.0
npm -v     # Should return a recent npm version (e.g. 10.x)

✅ 2. Install the .NET SDK

This project targets .NET 10. To make setup easier we pin the SDK via global.json so the correct SDK is used automatically by the dotnet CLI.

If you don't have the pinned SDK installed, install any 10.0.x SDK from:

👉 https://dotnet.microsoft.com/download

Verify installation:

dotnet --version   # Should return 10.0.x

✅ 3. Restore Local Tools and Dependencies

From the project root, run:

npm run init

This will run the following commands:

npm install
dotnet restore
dotnet tool restore

Commands for Dev Inner Loop

The following terminal commands are your dev inner loop:

To build and run in the dev server for iterative development: npm run dev
To build for deployment, including enforced TypeScript linting: npm run build
To host the deployment-ready build locally for testing: npx serve dist
To run all unit tests (.NET xUnit and Vitest, including Koota conformance): npm test
To run only the TypeScript/Vitest suite: npm run test:ts
To run only the portable Koota conformance suite: npm run test:koota
To enforce type-aware ESLint checks in hand-written TypeScript source, tests, and configuration files: npm run lint. Violations fail this command and npm run build.
To enforce the independent F# and TypeScript line/branch coverage baselines: npm run coverage:check
To generate coverage data for both languages: npm run coverage
- F# only: npm run coverage:fsharp
- TypeScript only: npm run coverage:ts
To generate and open both language-specific coverage reports: npm run report
- F# only: npm run report:fsharp
- TypeScript only: npm run report:ts
To format the TypeScript code with Prettier and F# code with Fantomas: npm run format
- Prettier is configured via the .prettierrc file in the project root. Files and folders to ignore are listed in .prettierignore.
- Fantomas is configured via the .editorconfig file in the project root.

bitsforthought/Wilnaatahl

README