Skip to content

kgcorner/chess-db

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

codecov CircleCI Quality Gate Status

chess-db

Chess-db is a small database for conveniently storing and fetching chess games and positions. You can use this in your chess app to store games. The database is build using Spring boot. You can easily integrate it with a spring boot service. It is currently being used at Scriptchess.com

Features

Currently below features are supported

  • Storing chess Game
  • Fetching games by FEN
  • Fetching moves and how many time it was played in certain position using FEN.

How to use

The db is made using Spring boot. Once will have to call ChessDbDriver.init() before using this db. The DB itself doesn't has any data. It's just a program and the user will have to add games

How to store games

Use ByteWisePGNProcessor to parse any given game in PGN format. And save the game using chessService.saveGame() saveGame method will save the game as well as the position and moves on the given position. If the position is reached in previous games then moves will be merged location for saving game files are define using property "games.path" and "fens.path" for position storage in application.properties file

Unit Tests results

code-coverage

Taken from codecov.

The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.

Code analysis

Code analysis is done using Sonarcloud

Reliability Rating Technical Debt Lines of Code Code Smells Maintainability Rating Security Rating Bugs Vulnerabilities Duplicated Lines (%)

Releases

No releases published

Packages

No packages published