This is a Mahjong game project developed using Java, JavaScript, TypeScript, and Spring Boot by BDIC Group X.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them
- Java
- Maven
- An IDE (like IntelliJ IDEA)
A step by step series of examples that tell you how to get a development environment running
- Clone the repo
git clone https://github.com/Mystour/mahjong.git
- Install Maven packages
mvn install
- Run the project
mvn spring-boot:run
Now, you should be able to see the project running at http://localhost:8080.
- Open your browser and navigate to https://github.com/Mystour/mahjong.
- On the login page, enter your username and password, then click the "login" button.
The game interface is divided into four sections, each representing the hand area of a player. Below each player's hand area is their discard pile.
- At the start of the game, each player is dealt a certain number of tiles.
- Players can select the tile they want to discard by clicking on it in their hand.
- The discarded tile is placed in the discard pile.
There is a speaker icon at the bottom right corner of the game interface. Clicking on it will play background music.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Mystour - https://github.com/Mystour
Project Link: https://github.com/Mystour/mahjong