The goal is to provide an accessible modern way of reading an old, beautiful story.
It includes QoL features such as savedata previews, an interactive flowchart, multiple languages support, and more.
The Progressive Web App (PWA) can be installed from the title screen using chromium-based browsers (e.g., Chrome, Edge, Opera).
It offers a better experience in general.
None of the original assets are provided with this repository.
To download the source code and run the game's code locally, follow one of the two methods:
- install
node.js(version18 / 20 / 22+is required) - Get the source code:
git clone --recursive - Install project dependencies with
npm i - Start the localhost with
npm start - Open your browser at the localhost address specified in the output of the previous command
Alternatively, Docker can be used for local deployment from a single command:
$ docker compose up -d
or, if you prefer to use the CLI,
$ docker build -t tsukiweb .
$ docker run -p 8080:80 tsukiweb
In addition, a version tag or commit hash can be specified as a build argument:
docker build --build-arg VERSION=latest -t tsukiweb
docker build --build-arg VERSION=v0.3.0 -t tsukiweb
docker build --build-arg VERSION=da4ea4f -t tsukiweb
In your browser, navigate to http://localhost:8080 after deploying the container.
Anyone wanting to contribute can download the project and follow the roadmap, or do something else entirely.
You can find our contributing guidelines here
- React (Vite)
- TypeScript
- SASS