{"id":20944572,"url":"https://github.com/intothevoid/chessapi","last_synced_at":"2026-05-20T00:03:42.965Z","repository":{"id":83522627,"uuid":"602817409","full_name":"intothevoid/chessapi","owner":"intothevoid","description":"Multiplayer Chess API in Python","archived":false,"fork":false,"pushed_at":"2023-02-28T11:50:05.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-19T21:38:41.706Z","etag":null,"topics":["api","api-rest","backend","chess","fastapi","game","multiplayer","python","rest","restful-api"],"latest_commit_sha":null,"homepage":"","language":"Python","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/intothevoid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-02-17T02:02:17.000Z","updated_at":"2023-02-17T08:01:27.000Z","dependencies_parsed_at":"2023-03-11T17:46:02.110Z","dependency_job_id":null,"html_url":"https://github.com/intothevoid/chessapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intothevoid%2Fchessapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intothevoid%2Fchessapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intothevoid%2Fchessapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intothevoid%2Fchessapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intothevoid","download_url":"https://codeload.github.com/intothevoid/chessapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243335419,"owners_count":20274904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api","api-rest","backend","chess","fastapi","game","multiplayer","python","rest","restful-api"],"created_at":"2024-11-18T23:42:43.408Z","updated_at":"2025-12-30T00:22:28.944Z","avatar_url":"https://github.com/intothevoid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Multiplayer Chess API\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/6/6f/ChessSet.jpg/500px-ChessSet.jpg\" width=50% height=50%\u003e\u003c/img\u003e\n\nThis is a backend service that allows developers to create, read, update, and delete multiplayer chess games. Chess is a popular game that has been around for centuries. Chess is a game that requires strategy and planning. This server could be used to create a chess game, a chess website, or a chess mobile app.\n\nThis server has five endpoints that allow developers to create, read, update, and delete multiplayer chess games.\n\n## Routes\n\n### GET /api/v1/games\n\nThis route returns a list of all the games in the database.\n\n#### Example Response\n\n```json\n[\n    {\n        \"id\": 1,\n        \"player1\": \"John\",\n        \"player2\": \"Jane\",\n        \"state\": \"rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2\"\n    },\n    {\n        \"id\": 2,\n        \"player1\": \"Vishwanathan\",\n        \"player2\": \"Gary\",\n        \"state\": \"4k2r/6r1/8/8/8/8/3R4/R3K3 w Qk - 0 1\",\n    },\n]\n```\n\n### POST /api/v1/games\n\nThis route creates a new game in the database. An ID is automatically generated for the game. If state is not provided, the game will start with the default chess board.\n\n#### Example Request\n\n```json\n{\n    \"player1\": \"John\",\n    \"player2\": \"Jane\",\n    \"state\": \"rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2\"\n}\n```\n\n#### Example Response\n\n```json\n{\n    \"id\": 3,\n    \"player1\": \"John\",\n    \"player2\": \"Jane\",\n    \"state\": \"rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2\"\n}\n```\n\n### GET /api/v1/games/{game_id}\n\nThis route returns a specific game in the database.\n\n#### Example Response\n\n```json\n{\n    \"id\": 1,\n    \"player1\": \"John\",\n    \"player2\": \"Jane\",\n    \"state\": \"rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2\"\n}\n```\n\n### PUT /api/v1/games/{game_id}\n\nThis route updates a specific game in the database.\n\n#### Example Request\n\n```json\n{\n    \"state\": \"rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2\"\n}\n```\n\n#### Example Response\n\n```json\n{\n    \"id\": 1,\n}\n```\n\n### DELETE /api/v1/games/{game_id}\n\nThis route deletes a specific game in the database.\n\n#### Example Response\n\n```json\n{\n    \"id\": 1,\n}\n```\n\n## Setup\n\n### Requirements\n\n- [Python 3.8](https://www.python.org/downloads/release/python-380/)\n- [Python Chess](https://python-chess.readthedocs.io/en/latest/)\n- [FastAPI](https://fastapi.tiangolo.com/)\n\n### Docker Install - Recommended\n\n1. Build docker image\n\n```bash\ndocker build -t intothevoid/chessapi .\n```\n\n2. Run docker container\n\n```bash\ndocker run --rm -d --name chessapi -p 8000:8000 intothevoid/chessapi\n```\n\n3. Open browser and go to http://localhost:8000/docs\n\n### Standard Install\n\n1. Clone the repository\n\n```bash\ngit clone https://github.com/intothevoid/chessapi.git\n```\n\n2. Install dependencies\n\n```bash\npython -m venv venv\nsource venv/bin/activate\npip install -r requirements.txt\n```\n\n3. Run the server\n\n```bash\nuvicorn chessapi.main:app --reload\n```\n\n4. Open browser and go to http://localhost:8000/docs\n\n## References\n\n- [Chess](https://en.wikipedia.org/wiki/Chess)\n- [FastAPI](https://fastapi.tiangolo.com/)\n- [FastAPI Code Generator](https://github.com/koxudaxi/fastapi-code-generator)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintothevoid%2Fchessapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintothevoid%2Fchessapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintothevoid%2Fchessapi/lists"}