lishogi-dev

Set up environments to run lishogi.org and develop on your local

Usage

Install Nix, Docker and direnv

git clone [email protected]:kachick/lishogi-dev.git
cd lishogi-dev
direnv allow
task setup
docker compose up --detach # MongoDB, Redis, lila-ws(websocket), shoginet(engine)
# You can check the back-end logs via `docker compose logs [service-name]`
task prepare_db

Replace shebang in ./repos/lishogi/ui/build if you working on NixOS

-#!/bin/bash -ea
+#!/usr/bin/env -S bash -ea

cd repos/lishogi
nix develop ../#lila # Enter in Nix dev shell, with nodejs, sbt
./ui/build
./lila # Enter in sbt console

[lila] $ compile
[lila] $ run
...

Open localhost:9663 in your web browser

If you want to stop the services

[lila] $ exit
cd ../../
$ docker compose down
...

Happy Shogi!

FAQ

Q. Broken behavaior after upstream changes
A. Update this repository to follow upstream, or run task pin

Q. How to update this repo?
A. Additional notes may be found in CONTRIBUTING.md

Motivation and concept

When I wanted a solution similar to lichess-org/lila-docker in lishogi, I couldn't find an overall solution.
So I started this project. I prefer nix as possible rather than docker except for simple back-ends like databases.