{"id":18098569,"url":"https://github.com/makiftutuncu/scrabble-api","last_synced_at":"2026-04-15T15:31:00.879Z","repository":{"id":152869447,"uuid":"196415250","full_name":"makiftutuncu/scrabble-api","owner":"makiftutuncu","description":"Scrabble Game API in Java","archived":false,"fork":false,"pushed_at":"2023-12-15T02:46:19.000Z","size":6089,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-06T04:18:11.610Z","etag":null,"topics":["flyway","hibernate","java","junit","postgresql","spring-mvc"],"latest_commit_sha":null,"homepage":null,"language":"TSQL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/makiftutuncu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-11T14:56:16.000Z","updated_at":"2024-10-24T18:22:54.000Z","dependencies_parsed_at":"2023-12-15T03:40:23.386Z","dependency_job_id":"7e4e6d6b-ca86-47d5-8a34-7903d2a81583","html_url":"https://github.com/makiftutuncu/scrabble-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/makiftutuncu/scrabble-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2Fscrabble-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2Fscrabble-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2Fscrabble-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2Fscrabble-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/makiftutuncu","download_url":"https://codeload.github.com/makiftutuncu/scrabble-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makiftutuncu%2Fscrabble-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31847489,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"ssl_error","status_checked_at":"2026-04-15T15:24:39.138Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flyway","hibernate","java","junit","postgresql","spring-mvc"],"created_at":"2024-10-31T20:11:51.742Z","updated_at":"2026-04-15T15:31:00.830Z","avatar_url":"https://github.com/makiftutuncu.png","language":"TSQL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scrabble API\n\n## Table of Contents\n\n1. [Introduction](#introduction)\n3. [Development and Running](#development-and-running)\n4. [Testing](#testing)\n5. [Contributing](#contributing)\n6. [License](#license)\n\n## Introduction\n\nScrabble API is backend application written in Java. It is a REST API for a simplified Scrabble word game with Turkish words.\n\nAt its core, Scrabble API is a [Spring MVC](https://spring.io/) app. It uses [Hibernate](https://hibernate.org/) for persistance to a [PostgreSQL](https://www.postgresql.org/) database. See [Development and Running](#development-and-running) for setting it up.\n\nA detailed API documentation is in [API.md](API.md).\n\nHere are rules and assumptions taken into account for the implementation of Scrabble API:\n\n* There can be multiple (game) boards.\n* A board can be disabled, if so, it cannot be re-enabled or modified.\n* Valid Turkish word(s) can be placed on a given board.\n* A word can be placed (i.e. making a move) anywhere on the board if the board is empty.\n* A word can be placed starting from an existing letter if the board is not empty.\n* Scoring is based on the points of letters of the words on the board, see [points of letters](LETTER_POINTS.md).\n* Boards, moves and words can be listed.\n\n## Development and Running\n\nScrabble API is built with [Gradle](https://gradle.org/) and it runs on [Apache Tomcat](http://tomcat.apache.org/) application server via [Gretty](http://akhikhl.github.io/gretty-doc/index.html) plugin.\n\nTo clean, compile, run and debug Scrabble API, you can use Gradle tasks `clean`, `compile`, `appRun` and `appRunDebug`. \n\nBefore 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](https://www.docker.com/)'s `docker-compose` by running in project's root directory:\n\n```docker-compose up -d```\n\nThe database schema will automatically be migrated via [Flyway](https://flywaydb.org/).\n\nHTTP and debug ports, application server etc. can be configured in [build.gradle](build.gradle).\n\nDatabase credentials can be configured in [database.properties](src/main/resources/database.properties) and [hibernate.cfg.xml](src/main/resources/hibernate.cfg.xml) for running the application. For testing, they are in [database.test.properties](src/test/resources/database.test.properties) and [hibernate.cfg.xml](src/test/resources/hibernate.cfg.xml). Please note that default configuration is aligned with [docker-compose.yml](docker-compose.yml) so you might need to update it as well. \n\n## Testing\n\nScrabble API contains [JUnit](https://junit.org/junit4/) tests. To run all the tests, use `test` task of Gradle.\n\n## Contributing\n\nPlease feel free to send a pull request for your contributions. Thank you.\n\n## License\n\nScrabble API is licensed with MIT License. See [LICENSE.md](LICENSE.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakiftutuncu%2Fscrabble-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmakiftutuncu%2Fscrabble-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakiftutuncu%2Fscrabble-api/lists"}