Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/efjerryyang/gomoku-online
Gomoku Online - HITSZ Distributed Systems Course Project 1 in Spring 2023. | 在线五子棋 - HITSZ 分布式系统 课程项目1 2023春
https://github.com/efjerryyang/gomoku-online
Last synced: 14 days ago
JSON representation
Gomoku Online - HITSZ Distributed Systems Course Project 1 in Spring 2023. | 在线五子棋 - HITSZ 分布式系统 课程项目1 2023春
- Host: GitHub
- URL: https://github.com/efjerryyang/gomoku-online
- Owner: efJerryYang
- Created: 2023-04-01T10:08:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-04T00:43:33.000Z (about 1 year ago)
- Last Synced: 2023-10-04T12:55:43.584Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 670 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gomoku Online
[English](./README.md) | [中文](./README_zh.md)
## Introduction
Gomoku Online - HITSZ Distributed Systems Course Project 1 in Spring 2023.
See `docs/` for more details:
- [setup-and-run-the-project](docs/setup-and-run-the-project.md): Detailed setup guide for the project.
- [documentation.md](docs/documentation.md): Documentation for the project.
- [documentation-appendix.md](docs/documentation-appendix.md): Appendix for the documentation (includes demo).
- [workflow.md](docs/workflow.md): Draft design of the workflow.
- [debugging-notes.md](docs/debugging-notes.md): Debugging notes.
## Tech Stack
| Tech stack | Description |
| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| [Vue.js](https://vuejs.org/) | A progressive JavaScript framework used for building user interfaces and single-page applications. |
| [Spring Boot](https://spring.io/projects/spring-boot) | A popular Java-based open-source framework used for building web applications. |
### How to run
Frontend is a `Vue.js` project, the built `dist` directory can be loaded by web server like `nginx`, or you can use `npm` to run it locally as follows:
```sh
cd gomoku-online-frontend/ # Goto frontend working directory
npm install # Project setup
npm run dev # Compile and hot-reload for development
```
Backend is a `Spring Boot` project. It is managed by `maven`, so you can run the following to build it manually:
```sh
cd gomoku-online-backend/ # Goto backend working directory
mvn install # Install necessary dependencies
mvn clean package # Build an executable jar file for the backend project
```
Alternatively, you can directly run the released `jar` binary in the following way. It is important to notice that you should replace the `` with the exact version of the `jar` file (e.g. `0.1.0`).
```sh
java -jar gomoku-online-.jar # Run the jar file
```
## Reference
- Inspired by the online gomoku game: [Play Gomoku Online](https://gomokuonline.com/)