Nine-Mens-Morris

Screen shot of game running

Running the Project

1. Create a Virtual Environment (Recommended but not necessary):

A virtual environment isolates project dependencies from your system's Python environment, preventing conflicts.

Steps:

• Open a terminal window. I opened a terminal in my IDE
• Navigate to the project directory.
• Create a virtual environment named venv:

  python -m venv venv

2. Activate virtual Environment

• On windows

  venv/Scripts/activate

• On Mac

  source venv/bin/activate

  3. Install dependencies

  pip install -r requirements.txt

  4. Run the program

  pip install -e .

  startgame

  • Run both of these commands at top project directory

Additonal notes:

• The app entry point is frontend/GameGUI.main
  • The setup.py file defines this

Running the tests in Visual Studio Code

1. Make sure the Python extension is installed

2. Run pytests discovery command to discover and run all unit tests

   pytest tests/

• To run test coverage and see how much of our code is covered by tests

  pytest --cov=NINE-MENS-MORRIS tests/

3. Configure Testing in the sidebar

• Select to use pytest, not unittest
• Select test naming option for 'test_*.py'
• Not sure if this is necessary for people using VSCode since the .vscode file is included in the repo

3. When writing new tests always put 'test_' at the front of every file name and test method name

• This is how pytest will find the test

Styling Guide

1. We are using the Microsoft style guide and to enforce this are making use of the python plugins:

• black (config file pyproject.toml)
• pylint (config file .pylintrc)

• isort (config file.isort.cfg)

  2. To Apply these auto-formatters to your code run the following commands at the top of the project directory:

• black .
• isort .
• pylint .

Debug Guide

1. The launch.json in the .vscode folder contains the configuration info for running the app from the 'Run and Debug' tab in vscode

• This allows us to place break points and full debug capabilities in both the backend and frontend code

2. The IDE should detect this right away. You may need to select to use the existing configuration file in the 'Run and Debug' tab