paulproteus/tictactoe-demo-app

About this codebase

This is an example of how to write an API using Django views to implement a public tic-tac-toe service.

For now, please don't copy it or run it yourself unless you have my permission. Lincoln and Drew have my permission!

Overview and structure

• This is a Django project, with one Django app embedded.

• If you read the Django project's settings, you'll see there is no database and most default features of Django such as CSRF protection and the ability to locate templates have been disabled. Tread carefully, and feel free to enable Django features as-needed.

• As you edit the codebase, run the tests with:

bash run_tests.sh

• Dependencies are defined in requirements.txt. The run_tests.sh script assumes you will create a virtualenv in env/.

• Most code changes will be done in tttproject/tttapp/gamelogic.py.

Tic-tac-toe implementation notes

• This implementation treats a board state as string.

• It uses minimax to find the best move to take. It is somewhat slow and redoes a large amount of work. Look for TODOs if you need to optimize for performance.

Data validation notes

• Data is validated directly in the Django view function.

Testing notes

• Currently, unit tests only cover the underlying gameplay, rather than also covering the HTTP (Django) views. If you re-add tests for the Django views, you probably will need to add a DATABASES value so that the Django test runner can use the test database. Alternatively, you may be able to use a RequestFactory and pass that to the Django view function.

Try the online demo

There is a demo instance available at https://aqueous-dawn-16235.herokuapp.com/.

Try it with this sample board: https://aqueous-dawn-16235.herokuapp.com/?board=+++++++++.