https://github.com/intothevoid/chessapi
Multiplayer Chess API in Python
https://github.com/intothevoid/chessapi
api api-rest backend chess fastapi game multiplayer python rest restful-api
Last synced: about 1 month ago
JSON representation
Multiplayer Chess API in Python
- Host: GitHub
- URL: https://github.com/intothevoid/chessapi
- Owner: intothevoid
- License: mit
- Created: 2023-02-17T02:02:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T11:50:05.000Z (over 3 years ago)
- Last Synced: 2025-01-19T21:38:41.706Z (over 1 year ago)
- Topics: api, api-rest, backend, chess, fastapi, game, multiplayer, python, rest, restful-api
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Multiplayer Chess API
This 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.
This server has five endpoints that allow developers to create, read, update, and delete multiplayer chess games.
## Routes
### GET /api/v1/games
This route returns a list of all the games in the database.
#### Example Response
```json
[
{
"id": 1,
"player1": "John",
"player2": "Jane",
"state": "rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2"
},
{
"id": 2,
"player1": "Vishwanathan",
"player2": "Gary",
"state": "4k2r/6r1/8/8/8/8/3R4/R3K3 w Qk - 0 1",
},
]
```
### POST /api/v1/games
This 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.
#### Example Request
```json
{
"player1": "John",
"player2": "Jane",
"state": "rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2"
}
```
#### Example Response
```json
{
"id": 3,
"player1": "John",
"player2": "Jane",
"state": "rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2"
}
```
### GET /api/v1/games/{game_id}
This route returns a specific game in the database.
#### Example Response
```json
{
"id": 1,
"player1": "John",
"player2": "Jane",
"state": "rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2"
}
```
### PUT /api/v1/games/{game_id}
This route updates a specific game in the database.
#### Example Request
```json
{
"state": "rnbqkbnr/pp1ppppp/8/2p5/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 0 2"
}
```
#### Example Response
```json
{
"id": 1,
}
```
### DELETE /api/v1/games/{game_id}
This route deletes a specific game in the database.
#### Example Response
```json
{
"id": 1,
}
```
## Setup
### Requirements
- [Python 3.8](https://www.python.org/downloads/release/python-380/)
- [Python Chess](https://python-chess.readthedocs.io/en/latest/)
- [FastAPI](https://fastapi.tiangolo.com/)
### Docker Install - Recommended
1. Build docker image
```bash
docker build -t intothevoid/chessapi .
```
2. Run docker container
```bash
docker run --rm -d --name chessapi -p 8000:8000 intothevoid/chessapi
```
3. Open browser and go to http://localhost:8000/docs
### Standard Install
1. Clone the repository
```bash
git clone https://github.com/intothevoid/chessapi.git
```
2. Install dependencies
```bash
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
3. Run the server
```bash
uvicorn chessapi.main:app --reload
```
4. Open browser and go to http://localhost:8000/docs
## References
- [Chess](https://en.wikipedia.org/wiki/Chess)
- [FastAPI](https://fastapi.tiangolo.com/)
- [FastAPI Code Generator](https://github.com/koxudaxi/fastapi-code-generator)