Skip to content

Repository files navigation

Fishnet Local Stack

Local chess review stack with:

  • a Fishnet-compatible HTTP endpoint for fishnet workers
  • a web UI for submitting PGNs and browsing completed reviews
  • a Lichess-style board and move list with focused review markers
  • persisted local job/review state

Disclaimer

This project is mainly coded with the help of Codex.

Requirements

  • Windows PowerShell for start-fishnet-stack.ps1
  • Node.js 20 or newer, with npm
  • A fishnet worker binary named fishnet.exe in the repository root

fishnet.exe is intentionally not included in this repo because it is a large platform-specific binary. Download/build the fishnet client separately from the upstream project, then place the executable next to package.json:

Fishnet-local-stack/
  fishnet.exe
  package.json
  start-fishnet-stack.ps1

Upstream fishnet:

Setup

Install dependencies:

npm install

Optional: create a local fishnet config from the example:

Copy-Item fishnet.example.ini fishnet.ini

fishnet.ini is ignored by Git so local worker settings can stay machine-specific.

Run

Start the API, web UI, and local fishnet worker:

.\start-fishnet-stack.ps1

Then open:

http://localhost:9665/

The startup script expects fishnet.exe in the repo root (download the latest release from: https://github.com/lichess-org/fishnet, and rename the executable to fishnet.exe), and starts it with:

--endpoint http://localhost:9665/fishnet --no-conf run

You can override the port or fishnet arguments:

.\start-fishnet-stack.ps1 -Port 9666 -FishnetArgs "--no-conf run"

Data

Runtime review state is stored in apps/api/data/state.json. That file is ignored by Git because it contains local analyzed games and can grow over time.

Development

Run the server without auto-starting fishnet:

npm start

Run tests:

npm test

Project Layout

  • apps/api: HTTP API, fishnet protocol endpoints, review generation, persisted state
  • apps/web/public: static web UI and vendored browser assets
  • docs: planning notes
  • fishnet.example.ini: safe example fishnet config
  • start-fishnet-stack.ps1: local convenience launcher

References

About

Lichess' fishnet plus API and web frontend for game review.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages