Scrabble API is backend application written in Java. It is a REST API for a simplified Scrabble word game with Turkish words.
At its core, Scrabble API is a Spring MVC app. It uses Hibernate for persistance to a PostgreSQL database. See Development and Running for setting it up.
A detailed API documentation is in API.md.
Here are rules and assumptions taken into account for the implementation of Scrabble API:
- There can be multiple (game) boards.
- A board can be disabled, if so, it cannot be re-enabled or modified.
- Valid Turkish word(s) can be placed on a given board.
- A word can be placed (i.e. making a move) anywhere on the board if the board is empty.
- A word can be placed starting from an existing letter if the board is not empty.
- Scoring is based on the points of letters of the words on the board, see points of letters.
- Boards, moves and words can be listed.
Scrabble API is built with Gradle and it runs on Apache Tomcat application server via Gretty plugin.
To clean, compile, run and debug Scrabble API, you can use Gradle tasks clean, compile, appRun and appRunDebug.
Before running the application for the first time, you will need to set up the database. In order to easily do that, you can use Docker's docker-compose by running in project's root directory:
docker-compose up -d
The database schema will automatically be migrated via Flyway.
HTTP and debug ports, application server etc. can be configured in build.gradle.
Database credentials can be configured in database.properties and hibernate.cfg.xml for running the application. For testing, they are in database.test.properties and hibernate.cfg.xml. Please note that default configuration is aligned with docker-compose.yml so you might need to update it as well.
Scrabble API contains JUnit tests. To run all the tests, use test task of Gradle.
Please feel free to send a pull request for your contributions. Thank you.
Scrabble API is licensed with MIT License. See LICENSE.md for details.