NutriTiger

NutriTiger is a new upcoming web application that allows Princeton students to track nutritional information from the dining halls.

Table of Contents

1. Installation
2. Contributing

Installation

1. Clone the repository

   git clone https://github.com/NutriTiger/NutriTiger.git

2. Install all required packages and python (version 3.11.7)

pip install -r requirements.txt

3. Configure .env file with tokens/secrets for the database. For CAS authentication, please specify the following environment variable

• MONGODB_USERNAME=
• MONGODB_PASSWORD=
• APP_SECRET_KEY=
• cloud_name =
• api_key =
• api_secret =
• usda_api_key =
• APP_SECRET_KEY=

4. python app.py

Contributing

Branching Guidelines

The general branch structure is as follows.

• main
• prototype (archived)
• alpha (archived)
• beta (archived)

Then, for stretch goals and other features, use the feature syntax Ex: feature/webscraping

Branching Commands:

Change to branch:

• git checkout feature/abc (equivalent to git branch feature/abc)

Make edits/commit/push accordingly to your branch freely.

When you are ready to bring your branch up to date with main...

• git checkout feature/frontend
• git pull origin main (this will bring any new changes to your branch)
• git push (now no longer "40 commits behind main")

When you are wanting to merge with main.

• git checkout main
• git merge feature/frontend
• Resolve any merge conflicts (can do visually)
• Commit changes git commit -m "Merging feature/frontend with main"
• git push origin main (origin is the configured remote name)

Miscellaneous Commands python –m pip freeze > requirements.txt

To tag a branch

• git checkout prototype
• git tag archive/prototype prototype
• git push --tags

Cronjob/scraping script Guidelines

The scraping script can be found in src/menuscript.py. You can run it with the following command:

• python src/menuscript.py

Database Guidelines

The db files (under src) require a mongodb username and password with read and write access to connect to the database. This information was previously shared to you.

When you are ready to run any of the database files, create a.env in the main NutriTiger directory by using the command, touch .env in the terminal. In that file, write the lines: MONGODB_USERNAME=<username> MONGODB_PASSWORD=<password> Replace <username> and <password> with the NutriTiger mongodb username and password accordingly.

Additionally, make sure your current IP address has network access. Go to the MongoDB Atlas Nutritiger project and click on "Network Access" on the left side menu. If you have the message that your current IP address is not added, click to add your current IP address to the access list. You must be connected to password protected WiFi to have network access.

To create a virtual environment, note "myvenv" is a name that can be replaced with whatever you prefer

python3.11 -m venv myvenv

To open the virtual environment

source myvenv/bin/activate

In order for the program to run, you must be using Python 3.11. Check your version within the virtual environment with: python --version, OR python3 --version

If there are issues with version, refer back to the Python download document.

If you face this error: SSL CERTIFICATE_VERIFY_FAILED certificate verify failed unable to get local issuer certificate, then Python is unable to verify the SSL certificate of a website you are trying to access. MacOS users may run this in the terminal (or find the Certificates.command and click it):

/Applications/Python\ 3.11/Install\ Certificates.command