Project Macbeth

Sprint Report

The sprint report for sprint one can be found here

Environment Setup Instructions

Django Backend Environment

We highly recommend running Macbeth's backend from a python virtual environment (venv). To set up a virtual environment, navigate to the repo directory and execute the following command:

py -m venv .venv

then select the virtual environment using one of the following:

For Windows:

./venv/Scripts/activate.bat

For Mac/Linux

# arguments for run-backend.sh:
# dropdb, creatdb, dropandrun, test, or nothing to run
./scripts/run-backend.sh
# In a new terminal instance
./scripts/run-frontend.sh

Once the virtual environment is loaded, you'll need to install the project dependencies. Run the following:

pip install -r requirements.txt

---

React Frontend Environment

Installing the frontend of Macbeth requires npm. npm is included in the installation node.js, but node is not used in the project.

To install the frontend, from the project repository, run the following commands:

cd macbeth_frontend
npm install

---

Running Macbeth

Project Macbeth is broken into two parts, the frontend and the backend, each are running as a distinct program. The backend must be running for the frontend to function.

Scripts for Windows and Linux/MacOS are provided to start both parts. From the project repository, run one of the following:

For Windows

scripts/startup.bat

For Linux

./scripts/run-backend.sh
./scripts/run-frontend.sh

---

Contribution

Project Macbeth is an open source project and is constantly evolving to support new models. If you are interested in contributing to the project, please be sure to read over the Contributors guide and the Code of Conduct.

---

Security

Please see the Security Guide for how to report security issues.