-
Clone this repository to local computer
-
Rename the directory to reflect the new project name
-
Create a new virtual environment
- Windows:
python -m venv ./venv
- Mac:
python3 -m venv ./venv
- Windows:
-
Activate the new virtual environment
- Windows:
.\venv\Scripts\activate
- Mac:
source ./venv/bin/activate
- Windows:
-
Install the dependencies
pip install -r requirements.txt
-
Install node modules
npm install
-Or this:
command line npm install -g npm
-
After adding a new python dependency run the freeze script at the .\ProfileUserEngine level to update the requirements.txt
pip freeze > requirements.txt
-
Run python files at the root level to avoid installing multiple
.venv
folders Example to run app.py:C:Users\user\Sequoia\ProfileUserEngine> python .\backend\app.py
- Select start.bat file in Windows explorer
- Alternatively run python .\backend\app.py
- Use `repr' to return variables for every class - EXTREMELY helpful for testing