Git Repo for team Scrumptious in CS 361 at Oregon State University!
This program can be run on Linux, MacOS, or Windows. If you are using Linux, it needs to be a version that has a desktop environment that is supported by Electron and a web browser. All information on installation and running the application are found in the README.md for the project files. This can run on any hardware that supports the previously mentioned operating systems released within the last eight(8) calendar years. They must also support the most recent version of Node JS. Network connectivity is only required to download the application files and install Node JS. You must have a screen larger than 1000(W) x 800(H) for the application to display as intended, but it can be ran on lower resolutions with some visual anomalies.
Download the files of the entire Github repository by clicking the greed "Code" button, then click "Download ZIP". After downloading, right click on the ZIP file and extract it.
Go to Node.js to get the most recent version of Node JS and npm (included in Node JS).
Launch the install.* script for your system. If you are on Linux or MacOS, use the one with the .sh suffix. If you are on Windows, use the one with the .ps1 suffix.
Launch the run.* script for your system. If you are on Linux or MacOS, use the one with the .sh suffix. If you are on Windows, use the one with the .ps1 suffix. (Note: This will open a terminal window that, if closed, will close the application. Do not close this terminal window.)
Add your great great grandma's peach cobbler recipe, your world famous PB & J recipe, or your aunt's spaghetti sauce recipe that you make once a year. Then, use the calendar to schedule when you plan to make these recipes. After meal planning, you can see all the things you need to buy for every recipe added to the calendar. If anything is missing, such as eggnog, you can add that manually to the list. Use the suggested tab if you don't know what you want to eat. If you want to track what you have in your pantry and fridge, you can add what you have into the pantry tab. Finally, use the search tab to find a recipe you added three months ago that started with an S.
git pull origin main //pulls main branch up to date on your system
git merge main //merges changes from the updated main branch into your current branch
git fetch //pulls updates on your branch incase there have been changes
- Make a new branch with a name that tells others what is being changed
- If you are making changes on multiple things or features, list them in your Pull Request
- Try to use one branch for one topic/feature/change
- Add comments so others can understand what your code does
- Create a new branch and push your changes to it, the branch protocols are listed above
- Create a Pull Request with a description that says everything you changed, especially if your branch name does not describe all your changes
- Message other people about your Pull Request so others can approve, comment on, or request changes to your request1
- If you are approving a Pull Request, be sure to merge and delete the branch with the request
- If you are commenting on a request, be sure to add something meaningful
- If you are requesting changes on a request, be sure to add what you think needs to be changed or fixed
- If changes are approved and merged onto the main branch, ensure the old branch is DELETED and NOT COMMITED TO EVER AGAIN! This is to ensure the cleanliness of the repo 👍
git checkout main //changes your working branch to main
git pull origin main //pulls main to ensure you have the most recent version
git reset --hard //clears old branches
Note: This will completely remove any old branches you've had on your system!
Footnotes
-
You can request specific people to review your Pull Request, which is recommended if you make changes to something that someone else has worked on previously ↩