tyronedamasceno / chessboard

Application to simulate a chessboard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Chessboard API

Application to simulate chess knight moves

Here, you can register some pieces and get all possible positions to a knight piece in two turns.

How to execute API?

The recommendation is to user Docker and docker-compose (if you need to install it on Ubuntu, I suggest this tutorial)

You just need to clone or download this repository, navigate into folder, then run the following commands:

$ docker-compose build

$ docker-compose up -d

Now, you have an running API on your localhost on the port 8000.

You may want have a local superuser, so run the command below and follow instructions.

$ docker-compose run --rm web python manage.py createsuperuser

You can use the provided credentials to access the admin interface on https://localhost:8000/admin/.

Documentation && try it out!

You can find API swagger documentation and do some tests https://localhost:8000/swagger/

Also, you can run unit automated tests running the following command

$ docker-compose run --rm web python manage.py test

Contact

I hope you enjoy it.

Feel free to contact me any time on telegram @tyronedamasceno or tyronedamasceno@gmail.com

About

Application to simulate a chessboard

License:MIT License


Languages

Language:Python 98.2%Language:Dockerfile 1.8%