kachick / lishogi-dev

Run and develop lishogi.org on your machine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

lishogi-dev

CI - Nix Status

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

Usage

Install Nix, Docker and direnv

git clone git@github.com: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
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.

About

Run and develop lishogi.org on your machine

License:GNU Affero General Public License v3.0


Languages

Language:Nix 47.6%Language:Shell 29.6%Language:Dockerfile 22.7%