Bananagrams

An online version of the game Bananagrams. The frontend and the backend are seperated in the frontend and backend directories respectively, so make sure to change into the proper directory before completing the following steps.

Setup - Backend

This app runs on Python 3 and uses poetry to maintain dependencies. Assuming you already have poetry installed and that you are in the backend directory, you can simply run

# 'poetry' must be installed first.

# Install minimal packages needed to run.
poetry install --no-dev

# Install all packages (for testing and development).
poetry install

Alternatively, you can use virtualenv with the included requirements files. After creating a new virtual environment for the project, run

# Make sure you have created the virtual environment and are currently in it.

# Install minimal packages needed to run.
pip install -r requirements.txt

# Install all packages (for testing and development).
pip install -r dev-requirements.txt

After setting up the environment, just run

python app.py

Test - Backend

To test the backend, make sure you have the correct virtual environment setup and are in the backend directory, and run

pytest tests/

For running the tests the prefered way (multiple cores, verbose output, no warnings), run

pytest -n 4 -v --disable-warnings tests

Or to run coverage, run

coverage run -m pytest tests/
coverage report

Test - Frontend

For node management, we will use nvm.

One time setup:

Install nvm (node version manager) via these instructions (https://github.com/nvm-sh/nvm)[here]

Then, in the cli, in the frontend directory, run nvm install 12.0.0 to install version 12.0.0. Finally, install the necessary packages using npm i

Everytime you start the frontend locally, run

nvm use 12.0.0
npm run start