https://github.com/igncp/mahjong

一個玩麻雀的網站應用程序，程式碼用 Rust 和 Typescript 編寫
https://github.com/igncp/mahjong

actix-web diesel docker github-authentication hong-kong mahjong nextjs nix playwright postgresql redis rust rxjs typescript wasm web-assembly

Last synced: 27 days ago
JSON representation

一個玩麻雀的網站應用程序，程式碼用 Rust 和 Typescript 編寫

• Host: GitHub
• URL: https://github.com/igncp/mahjong
• Owner: igncp
• License: mit
• Created: 2023-03-12T05:31:38.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-22T14:46:33.000Z (about 1 year ago)
• Last Synced: 2024-12-22T15:36:00.426Z (about 1 year ago)
• Topics: actix-web, diesel, docker, github-authentication, hong-kong, mahjong, nextjs, nix, playwright, postgresql, redis, rust, rxjs, typescript, wasm, web-assembly
• Language: Rust
• Homepage: https://mahjong-rust.com
• Size: 2.31 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 麻雀 - Mahjong

![Checks](https://github.com/igncp/mahjong/actions/workflows/checks.yml/badge.svg) ![Deploy](https://github.com/igncp/mahjong/actions/workflows/deploy.yml/badge.svg)

Hong Kong style mahjong game engine and web application. It uses a server to

handle games which handles most of the game mechanics.

1. Core library with the game mechanics, tests, and AIs focused in performance and correctness

1. Service that persists and handles games for clients

    - Can be communicated via an HTTP API

    - It creates a WebSocket per active game, to process the game and communicate with clients

1. Scripts to handle different tasks related to the code deployment and tests

    - For example running linting, tests, and deploying to Dockerhub

1. Web client to play, both for desktop and mobile web

    - It uses a drag-n-drop UI to play, and it has translated texts

    - Includes E2E tests

1. A Rust cli for running simulations

You can find the project's Rust documentation [here](https://mahjong-rust.com/doc/mahjong_core).

## Development

There is a [flake.nix](./flake.nix) file with all the required libraries needed

for development, including android, it requires that you have the Nix

package manager installed.

Once you have cloned the repository there are a few things to setup:

1. Generate the `.env` files where present by copying the templates

1. Install the dev dependencies: `cd scripts && bash src/main.sh dev_install`