https://github.com/project-mikoshi/crazy-8s
https://github.com/project-mikoshi/crazy-8s
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/project-mikoshi/crazy-8s
- Owner: Project-Mikoshi
- License: mit
- Created: 2022-11-14T21:14:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T22:12:12.000Z (over 3 years ago)
- Last Synced: 2025-12-25T22:34:15.178Z (6 months ago)
- Language: TypeScript
- Size: 346 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## How to start server
```bash
mvn clean
mvn mvn compile
mvn spring-boot:run
```
## How to open the web app
```md
after server has been started, visit localhost:8080 to check out the the web page
```
## How to run all tests
```bash
mvn test
```
## Log
```md
acceptance testing takes a long time and may occasionally fail due to uncertain race conditions, there's a log.txt file under the root directory to show test cases does pass in one shot
```
## Project Structure
```md
├── README.md <- doc
├── client <- frontend code (react + vite)
├── pom.xml
└── src <- backend code (spring boot + netty socket io)
└── test
└── resources
├── features <- acceptance test features
│ └── multiplayer.feature
```
## About Commit
```md
[code] <- game util function code that are tested by matching unit tests
[u-test] <- unit testings for util function related to game
[a-test] <- acceptance tests related to game features
[refactor] <- code that improve but does not change the existing behavior of game
[ui] <- ui code that does not require unit tests
[network] <- server or game module related networking handling code
[ui+network] <- synchronous backend and frontend code changes
[doc] <- documentation update
[init] <- initial project dependencies, build steps, directories setup, continuous integration setup
```