Marvellous mapping machine

Development instructions for backend

Preparation

Ensure you have Python v3.10+ installed.

Clone the repository and change directory to the backend folder in this repository:

cd backend

Virtual environment

Create a virtual environment. For example, on a personal computer running Linux, you can create a venv in the project directory:

python3 -m venv .venv

If you're on a school computer, you can't create a venv in your H: drive, so create it somewhere on the C: drive. E.g. in Git Bash:

py -m venv "$USERPROFILE/venvs/marvellous-mapping-machine"

Or in Powershell:

py -m venv "$env:USERPROFILE\venvs\marvellous-mapping-machine"

Activate the virtual environment

In VSCode, run the Python: Select Interpreter command. If the venv is in the project directory, you can directly select it from the list. If it's elsewhere, manually enter the path to the venv.

Alternatively, activate the venv in the terminal, e.g. in Linux:

source .venv/bin/activate

Install dependencies

python -m pip install -r backend/requirements.txt

Run the program

python backend/main.py

Development instructions for frontend

Preparation

Ensure you have Node.JS and Yarn v1 installed.

Clone the repository and change directory to the frontend folder in this repository:

cd frontend

Install dependencies

Run:

yarn

Start development server

Run

yarn dev

And access the frontend using the URL displayed in your terminal.