As a FYI to somebody browsing my github: this was an academic project done with three other students. Some of the code is not my own, and there was an enormous time pressure on the project.
For personal use only, all rights reserved.
Notes:
- All source files are located in the src directory
- Resources includes external licensed assets
- As is, the project is designed to run as a local instance, accessed by localhost
- The adjustments made on cs-devel have not been pushed to this repository, since the changes are specific to the hosting situation
docker-compose up
if you don't want to see the logs after you start it up you can run this instead
docker-compose up -d
docker-compose down
docker exec -it api bash
python test_engine_unittest.py
This clever little script, definitely not hodge-podged from StackOverflow, will restart the API server ever time a file in the directory is touched with a five second delay.
Just long enough to make a quick adjustment!
handles all the http requests on the api side, handling newgame requests, piece and wall movements, and player queue
handles a few in-between functions for making games
holds the main body of the api:
all the classes (tile, game, and player) with appropriate methods as well as all currently active games
Django APP is located in /src/client/quoridor_site/quoridor_site_backend/
Django site is located in /src/client/quoridor_site/quoridor_site/
NPM environmnet is located in /src/client/quoridor_site/
- The default package manager is yarn, which can be invoked in this directory
./package.json
is the package.json file for the project- The JS files used for this project are located in
./quoridor_site_backend/static/
The primary js file which handles the game rendering is called game_canvas.js
The file which handles the queueing mechanism on the user side is located in queue.js
.
Note: there may be several files in our project which have since been depricated.