diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..91c85e4b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +*.png filter=lfs diff=lfs merge=lfs -text +*.jpeg filter=lfs diff=lfs merge=lfs -text +*.jpg filter=lfs diff=lfs merge=lfs -text diff --git a/PantryNodeReact/public/logo192.png b/PantryNodeReact/public/logo192.png index fc44b0a3..4652f369 100644 Binary files a/PantryNodeReact/public/logo192.png and b/PantryNodeReact/public/logo192.png differ diff --git a/PantryNodeReact/public/logo512.png b/PantryNodeReact/public/logo512.png index a4e47a65..ba6e512c 100644 Binary files a/PantryNodeReact/public/logo512.png and b/PantryNodeReact/public/logo512.png differ diff --git a/README.md b/README.md index 1b017fcd..d0c0c259 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ In this project, we have implemented food pantry management using a NodeJS-based > Back-End -- MongoDB +- Postgres - Express JS - JavaScript @@ -50,6 +50,22 @@ In this project, we have implemented food pantry management using a NodeJS-based $ cd PantryNode ``` +### Git LFS + +- If images or other large files are needed install [Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) + +- After installation run the follow commands to pull the images and not just text pointers + +```shell +$ git lfs fetch --all +``` + +```shell +$ git lfs pull +``` + +### .env Setup + > Create a .env file with the following contents #DB CONFIG diff --git a/contributing.md b/contributing.md index eb7a9a62..cb2bdd0e 100644 --- a/contributing.md +++ b/contributing.md @@ -13,8 +13,9 @@ As an open source project, we welcome all contributors. Contributors shall abide 1. Create a feature branch with a concise 1-3 word name that adopts `snake_case` formatting and is descriptive enough to make its purpose clear without reviewing its source. 2. Commit discrete steps in resolving the issue with concise but descriptive commit messages. Any commit that completes resolving an issue should use [GitHub keywords for automating closing the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) (e.g. "Adds main menu, **closes #1**). If anyone made meaningful contributions to the work (such as participating in pair programming), credit them with a mention in the commit message (e.g. "Correct segfault error; @username contributed") and they should be added as an "Assigned to" contributor if they are not already. - 3. Push your changes to your feature branch and create a Pull Request. If your Pull Requests does not pass automated checks and/or contains unresolved conflicts, the person who submitted the PR is expected to address the problems before the PR will be reviewed. - 4. All PR containing procedural code should also include associated and thorough [Jest unit tests](https://jestjs.io/) that document and test the expected behavior. All new tests (both existing regression tests and new tests) should run and pass on the feature branch. Branch coverage should be 100\%. If there is a compelling reason why that threshold cannot be reached, a detailed explanation should be provided along with the PR description. - 5. A minimum of two other team members will review the Pull Request and provide discussion and/or constructive feedback. Engage in communication within the Issue comments. - 6. If at least two other team members have reviewed and approved the Pull Request, it will be merged into the `main` branch using **Rebase and Merge**, unless the commits are too granular (according to the concensus of the reviewers) in which case **Squash and Merge** will summarize the commits into a single commit. - 7. Once the Pull Request has been accepted and merged, the feature branch should be deleted from the repository \ No newline at end of file + 3. Ensure that all large files, including all images are tracked using Git LFS. + 4. Push your changes to your feature branch and create a Pull Request. If your Pull Requests does not pass automated checks and/or contains unresolved conflicts, the person who submitted the PR is expected to address the problems before the PR will be reviewed. + 5. All PR containing procedural code should also include associated and thorough [Jest unit tests](https://jestjs.io/) that document and test the expected behavior. All new tests (both existing regression tests and new tests) should run and pass on the feature branch. Branch coverage should be 100\%. If there is a compelling reason why that threshold cannot be reached, a detailed explanation should be provided along with the PR description. + 6. A minimum of two other team members will review the Pull Request and provide discussion and/or constructive feedback. Engage in communication within the Issue comments. + 7. If at least two other team members have reviewed and approved the Pull Request, it will be merged into the `main` branch using **Rebase and Merge**, unless the commits are too granular (according to the concensus of the reviewers) in which case **Squash and Merge** will summarize the commits into a single commit. + 8. Once the Pull Request has been accepted and merged, the feature branch should be deleted from the repository \ No newline at end of file diff --git a/docs/Foodbank ER Diagram.png b/docs/Foodbank ER Diagram.png index b7dc477b..6a61f9a0 100644 Binary files a/docs/Foodbank ER Diagram.png and b/docs/Foodbank ER Diagram.png differ diff --git a/docs/new.jpeg b/docs/new.jpeg index 7d649a60..2721978c 100644 Binary files a/docs/new.jpeg and b/docs/new.jpeg differ diff --git a/docs/old.jpeg b/docs/old.jpeg index 5d1ca091..8c2bb91e 100644 Binary files a/docs/old.jpeg and b/docs/old.jpeg differ diff --git a/public/images/assets/cart.png b/public/images/assets/cart.png index 46b7db89..aa29f6f7 100644 Binary files a/public/images/assets/cart.png and b/public/images/assets/cart.png differ diff --git a/public/images/assets/donor.png b/public/images/assets/donor.png index 14bd96d4..3e031ac1 100644 Binary files a/public/images/assets/donor.png and b/public/images/assets/donor.png differ diff --git a/public/images/assets/exp.png b/public/images/assets/exp.png index 1fa4e910..6085ed29 100644 Binary files a/public/images/assets/exp.png and b/public/images/assets/exp.png differ diff --git a/public/images/assets/report.png b/public/images/assets/report.png index 498730f5..767c25ff 100644 Binary files a/public/images/assets/report.png and b/public/images/assets/report.png differ diff --git a/public/images/assets/shop.png b/public/images/assets/shop.png index bf612517..181f58a5 100644 Binary files a/public/images/assets/shop.png and b/public/images/assets/shop.png differ diff --git a/public/images/icons/book.png b/public/images/icons/book.png index a02c0534..789bfe54 100644 Binary files a/public/images/icons/book.png and b/public/images/icons/book.png differ diff --git a/public/images/icons/bread.png b/public/images/icons/bread.png index 7e04107c..0bd698c8 100644 Binary files a/public/images/icons/bread.png and b/public/images/icons/bread.png differ diff --git a/public/images/icons/dairy.png b/public/images/icons/dairy.png index 80c7ab1c..b3205e66 100644 Binary files a/public/images/icons/dairy.png and b/public/images/icons/dairy.png differ diff --git a/public/images/icons/fruit.png b/public/images/icons/fruit.png index 6da8406b..024751e3 100644 Binary files a/public/images/icons/fruit.png and b/public/images/icons/fruit.png differ diff --git a/public/images/icons/meat.png b/public/images/icons/meat.png index 1ec7793a..40148952 100644 Binary files a/public/images/icons/meat.png and b/public/images/icons/meat.png differ diff --git a/public/images/icons/pen.png b/public/images/icons/pen.png index 541976b5..4535c999 100644 Binary files a/public/images/icons/pen.png and b/public/images/icons/pen.png differ diff --git a/public/images/icons/pencil.png b/public/images/icons/pencil.png index 89f68ea7..5a1fd9e8 100644 Binary files a/public/images/icons/pencil.png and b/public/images/icons/pencil.png differ diff --git a/public/images/icons/ready.png b/public/images/icons/ready.png index d0d22759..3bb3eca8 100644 Binary files a/public/images/icons/ready.png and b/public/images/icons/ready.png differ diff --git a/public/images/icons/vege.png b/public/images/icons/vege.png index 7a5e6bb3..76a697f3 100644 Binary files a/public/images/icons/vege.png and b/public/images/icons/vege.png differ diff --git a/public/images/log.png b/public/images/log.png index ca88989e..2e945ff1 100644 Binary files a/public/images/log.png and b/public/images/log.png differ diff --git a/public/images/logo.png b/public/images/logo.png index b1464ee2..ea05ad10 100644 Binary files a/public/images/logo.png and b/public/images/logo.png differ diff --git a/public/images/logo_w.png b/public/images/logo_w.png index 90f10005..db487fa0 100644 Binary files a/public/images/logo_w.png and b/public/images/logo_w.png differ diff --git a/public/images/logo_w2.png b/public/images/logo_w2.png index 64c09186..dd137ca5 100644 Binary files a/public/images/logo_w2.png and b/public/images/logo_w2.png differ diff --git a/public/images/magenta.jpg b/public/images/magenta.jpg index 1922c11e..bdaa1a8c 100644 Binary files a/public/images/magenta.jpg and b/public/images/magenta.jpg differ