Compare commits

...

4 commits

Author SHA1 Message Date
812b16e414
ci: fix check and deploy workflows
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ib9590566fe1a41f64316f5ab56957b116a6a6964
2026-04-09 08:33:21 +03:00
7b01c44039
docs: make project README less platform-agnostic
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ic42a9508cee4a141e28d216bd024af546a6a6964
2026-04-09 08:33:20 +03:00
NotAShelf
f19f39efe1 meta: auto-update dependencies 2026-04-09 05:32:57 +00:00
774e54de84
chore: update ignore filters for new layout
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: If3361dc6012a6214715f47f6dc5e8e9b6a6a6964
2026-04-09 08:32:12 +03:00
6 changed files with 30 additions and 13 deletions

View file

@ -25,6 +25,9 @@ jobs:
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- name: Build core packages
run: pnpm -r --filter '!@ns/web' build
- run: pnpm run check - run: pnpm run check
- run: pnpm run lint - run: pnpm run lint
- run: pnpm run fmt --check - run: pnpm run fmt --check

View file

@ -35,13 +35,16 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: pnpm install --frozen-lockfile run: pnpm install --frozen-lockfile
- name: Build - name: Build core packages
run: GITHUB_PAGES=true pnpm run build run: pnpm -r --filter '!@ns/web' build
- name: Build web app
run: GITHUB_PAGES=true pnpm run build:web
- name: Upload artifact - name: Upload artifact
uses: actions/upload-pages-artifact@v4 uses: actions/upload-pages-artifact@v4
with: with:
path: dist path: packages/web/dist
deploy: deploy:
needs: build needs: build

9
.gitignore vendored
View file

@ -1,4 +1,7 @@
# Nix
/.direnv/ /.direnv/
/node_modules/ /result*
/dist/
/result*/ # pnpm
**/node_modules/
**/dist/

View file

@ -1,7 +1,7 @@
/node_modules/
/dist/
/.direnv /.direnv
.eslintcache .eslintcache
*.md *.md
*.yml *.yml
.DS_Store .DS_Store
**/node_modules
**/dist

View file

@ -30,6 +30,11 @@ regressions in subsequent exports.
## Usage ## Usage
NS provides both a web application for pretty visuals, and a terminal client (a
TUI) for rendering the statistics from your terminal.
### Web
Usage instructions are provided in the initial page. Simply navigate to the site Usage instructions are provided in the initial page. Simply navigate to the site
and provide the JSON export (or a file) to render the statistics. The number of and provide the JSON export (or a file) to render the statistics. The number of
rendered fields might differ based on your Nix version or implementation (Lix, rendered fields might differ based on your Nix version or implementation (Lix,
@ -61,7 +66,7 @@ analysis you may compare two _named_ analyses at a time.
> UI bugs or areas where UI polish is very clearly missing. Please crate an > UI bugs or areas where UI polish is very clearly missing. Please crate an
> issue if the generated graph or the site UI looks off. Thanks :) > issue if the generated graph or the site UI looks off. Thanks :)
### Snapshots #### Snapshots
Snapshots are an "experimental" (just means they're new and unpolished) feature Snapshots are an "experimental" (just means they're new and unpolished) feature
that lets you save an analysis in your browser storage with a name to be used that lets you save an analysis in your browser storage with a name to be used
@ -72,9 +77,12 @@ You can save an analysis as a snapshot from the save button on the bottom right.
## Hacking ## Hacking
This project is built with Vite, using Typescript-React (`.tsx`) and SolidJS. A This project is built with various web technologies. Namely we use Vite,
Nix shell is provided, and dependencies can be fetched with `pnpm` while inside Typescript-React (`.tsx`) and SolidJS for most of our user interfaces.
the dev shell.
The recommended approach for resolving dependencies is using Nix; a Nix shell is
provided, and dependencies can be fetched with `pnpm` while inside the dev
shell.
```bash ```bash
# Run the live server # Run the live server

View file

@ -20,7 +20,7 @@ stdenv.mkDerivation (finalAttrs: {
pnpmDeps = fetchPnpmDeps { pnpmDeps = fetchPnpmDeps {
inherit (finalAttrs) pname src; inherit (finalAttrs) pname src;
hash = "sha256-5u2FmPYLRadLZeH6dRuoiXVejic7Z6JM4IzIdwLif/A="; hash = "sha256-zhdgC+sjIUAUsStG3H8RfVSrbhQG62a3zXeIPTUoGbI=";
fetcherVersion = 3; # https://nixos.org/manual/nixpkgs/stable/#javascript-pnpm-fetcherVersion fetcherVersion = 3; # https://nixos.org/manual/nixpkgs/stable/#javascript-pnpm-fetcherVersion
}; };