Skip to content
This repository has been archived by the owner on Jun 16, 2020. It is now read-only.

tckb/connectN-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 

Repository files navigation

basic.README

A simple implementation of Connect-N gamming backend server. Some of salient features include:

  • An N-connected board with size KXP, all of which can be configured via setup.
  • The game is implemented to support Multi-player including a (dumb!) version of AI the player can play against to.
  • Inherently, as the game works based on player and game ids, the game supports multisession as well!

Technologies/Framework considered

  • Java >=1.8
  • Spring-boot(=1.3.2.RELEASE) for creating a micro-service, instead of full-blown framework.
  • Embedded MongoDB as a no-SQL database for storing board/player related details.

System reqirements

The recommended configurations for building from the source:

  • Oracle Java SDK >= 1.8.*
  • Maven 3.2.*
  • git 2.4.*

Downloading and Building
$ git clone https://github.com/tckb/connectN-backend.git
$ cd connectN-backend
$ mvn clean package

The above command will download the required dependencies and will create the jar file of the application in target folder incuding the documentation of the source.

Source documentation

While packaging, maven creates the java documentation of the project as well.

$ cd connectN-backend
$ open target/apidocs/index.html

Incase of using windows, use start instead of open.

Runnning the application

The application has an inbuilt embedded server, so suffice to have only JRE (>=1.8.*).

$ cd connectN-backend
$ java -jar target/connect4-<version>.jar

By default, the server runs on port 8090 . To change any project related configuration please see [application.properties] app-props.link. For more detailed configuration, please consult spring-boot-application.properties

Additional requirements

The project uses embedded mongodb for storing application related information, if you are curious to see the data yourself, you must install a mongodb-compliant client. By default, the mongodb runs on port 2003 (see property file).

For eg:

mongo 127.0.0.1:2003/test
show collections
current_boards → 0.000MB / 0.008MB
expired_boards → 0.000MB / 0.008MB

Continued more @ Rest.README.

About

A small backend server for connect4 game.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages