TripleT

RecipeBuddy - CSC307 Group Software Project

We wanted to build an app that helps people save and share recipes with eachother. Additionally, when people cook at home they don't know the price of the meal. These are all the issues RecipeBuddy solves. RecipeBuddy is a digital recipe book where everyone can connect and view eachother's recipes. Futher, whenever someone inputs a recipe, the app will calculate the cost for the defined amount of each ingredient (given the cost per weight or cost per volume sold by Kroger Groceries). With this, the user can see the total cost of the meal and price per serving of their recipe. It is great for people who want to budget and be inspired to cook at home rather than eat out!

Demo video

UML diagram

Azure deployment

UI prototype

Sequence Diagram for the sign up process

code coverage report (with date and time)

Setup Project Environment

For app to work properly set up in the following order: MongoDB Cloud -> Backend -> Frontend

Setup Mongo DB

• Intall on Windows
• install MongoDB Compass
• Open MongoDB Compass and connect using DB URL in your .env file

Setup Backend

• move terminal to TripleT/backend and run $ npm install
• to run backend, navigate to backend folder and run $ npx nodemon index.js
• to test backend using jest, run $ npm test

Setup Frontend

• move terminal to TripleT/frontend and run $ npm install
• to run frontend locally, navigate to frontend folder, then src and run $ npm start

Style Check/Linter

RecipeBuddy uses the Mozilla Firefox style guide found here

• Editor integration

  Editor integration can be found here

• Command-line

  If you prefer to use command-line interface, navigate to your root directory and input npm install -g prettier Once packages have been added, you may run prettier locally using prettier /filename to run prettier on a specific file or prettier --write . to run prettier on all files at root

If you recive the error message on Windows 8.0+ Management_Install.ps1 cannot be loaded because the execution of scripts is disabled on this system.

• As an Administrator, you can set the execution policy by typing this into your PowerShell window:

  Set-ExecutionPolicy RemoteSigned

  For more information, see Using the [Set-ExecutionPolicy Cmdlet](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set- executionpolicy?view=powershell-7.3).

• When you are done, you can set the policy back to its default value with:

  Set-ExecutionPolicy Restricted

Relational Diagram

Relational diagram for user signup process:

License

MIT License