Gomoku Online

English | 中文

Introduction

Gomoku Online - HITSZ Distributed Systems Course Project 1 in Spring 2023.

See docs/ for more details:

• setup-and-run-the-project: Detailed setup guide for the project.
• documentation.md: Documentation for the project.
• documentation-appendix.md: Appendix for the documentation (includes demo).
• workflow.md: Draft design of the workflow.
• debugging-notes.md: Debugging notes.

Tech Stack

Tech stack	Description
Vue.js	A progressive JavaScript framework used for building user interfaces and single-page applications.
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:

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:

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 <version> with the exact version of the jar file (e.g. 0.1.0).

java -jar gomoku-online-<version>.jar # Run the jar file

Reference

• Inspired by the online gomoku game: Play Gomoku Online