src

Portion Mate

Source Code Manual

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• git (optional): To have a copy of this code, you can clone it using Git, however you can also download a ZIP of the repository.

git clone https://github.com/ineshbose/portion-mate
cd portion-mate/src   # treat src as root

• poetry / pip: The backend uses Django, and therefore dependencies can be installed using either pip or poetry (preferred).

python3 -m venv env               # optional
source ./env/scripts/activate     # activate environment
poetry install
pip install .                     # if you don't use poetry

• yarn / npm: The frontend uses React Native, and therefore dependencies can be handled using either npm or yarn (preferred).

yarn install
npm install    # if you don't use yarn

Running

This will require you to run backend and frontend separately using two terminals.

• Backend

python manage.py

• Frontend

yarn start
npm start      # if you don't use yarn