Feedback

.circleci/config.yml

@@ -4,46 +4,46 @@ version: 2.1
 
 # Define the jobs we want to run for this project
 jobs:
-  build-and-test-express-js:
-    docker:
-      - image: cimg/node:16.13.0 # latest stable node at the time of writing
-        # auth:
-        #   username: mydockerhub-user
-        #   password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
-    steps:
-      - checkout
-      - run: echo "this is the build and test express.js job"
-      - run: |
-          cd back-end
-          pwd # for debugging: show current working directory
-          ls # for debugging: show sub-directories in here
-      - run: |
-          cd back-end
-          npm install # install all dependencies listed in package.json
-          npm test # run all unit tests
-  build-react-js:
-    docker:
-      - image: cimg/node:16.13.0 # latest stable node at the time of writing
-        # auth:
-        #   username: mydockerhub-user
-        #   password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
-    steps:
-      - checkout
-      - run: echo "this is the build react.js job"
-      - run: |
-          cd back-end
-          pwd # for debugging: show current working directory
-          ls # for debugging: show sub-directories in here
-      - run: |
-          cd front-end
-          npm install # install all dependencies listed in package.json
-          npm run build # have react build the stand-alone front-end code
+    build-and-test-express-js:
+        docker:
+            - image: cimg/node:16.13.0 # latest stable node at the time of writing
+              # auth:
+              #   username: mydockerhub-user
+              #   password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
+        steps:
+            - checkout
+            - run: echo "this is the build and test express.js job"
+            - run: |
+                  cd back-end
+                  pwd # for debugging: show current working directory
+                  ls # for debugging: show sub-directories in here
+            - run: |
+                  cd back-end
+                  npm install # install all dependencies listed in package.json
+                  npm test # run all unit tests
+    build-react-js:
+        docker:
+            - image: cimg/node:16.13.0 # latest stable node at the time of writing
+              # auth:
+              #   username: mydockerhub-user
+              #   password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
+        steps:
+            - checkout
+            - run: echo "this is the build react.js job"
+            - run: |
+                  cd back-end
+                  pwd # for debugging: show current working directory
+                  ls # for debugging: show sub-directories in here
+            - run: |
+                  cd front-end
+                  npm install # install all dependencies listed in package.json
+                  npm run build # have react build the stand-alone front-end code
 
 # Orchestrate our job run sequence
 workflows:
-  build-and-test-back-end:
-    jobs:
-      - build-and-test-express-js
-  build-front-end:
-    jobs:
-      - build-react-js
+    build-and-test-back-end:
+        jobs:
+            - build-and-test-express-js
+    build-front-end:
+        jobs:
+            - build-react-js

.github/workflows/back-end.yml

@@ -0,0 +1,36 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Back-end CI
+
+on:
+    push:
+        branches: ["master"]
+    pull_request:
+        branches: ["master"]
+    schedule:
+        - cron: "0 2 * * 1-5"
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [14.x, 16.x, 18.x]
+                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  cache: "npm"
+            - name: Install dependencies
+              run: |
+                  cd back-end
+                  npm ci
+                  npm run build --if-present
+
+#     - run: npm test

.github/workflows/front-end.yml

@@ -0,0 +1,34 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Front-end CI
+
+on:
+    push:
+        branches: ["master"]
+    pull_request:
+        branches: ["master"]
+    schedule:
+        - cron: "0 2 * * 1-5"
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [14.x, 16.x, 18.x]
+                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  cache: "npm"
+            - name: Install dependencies
+              run: |
+                  cd front-end
+                  npm ci
+                  npm run build --if-present

.gitignore

@@ -79,6 +79,10 @@ node_modules/
 jspm_packages/
 **/jspm_packages
 
+# public uploads Directory
+public/*
+!public/uploads/
+
 # Results of React build script
 build/
 **/build/
@@ -114,6 +118,9 @@ typings/
 # dotenv environment variables file
 .env
 
+# dotenv environment variables file
+/*.env
+
 # next.js build output
 .next
 

CONTRIBUTING.md

@@ -1,2 +1,78 @@
 # Guide to Contributing
-Delete the contents of this file and replace with the contents of a proper guide to contributing to this project, as described in the [instructions](./instructions.md)
+Thank you for putting in the  time to contribute to  our project! </br>
+Continue reading to get an overview of our team norms as well as the contribution workflow.
+## Team norms
+### Team values
+#### How the team will work together
+* All team members will contribute to the project during every sprint, working to complete their assigned tasks.
+* All team members will attend and enagage in scheduled meetings on zoom or in-person.
+#### How members who need help will solicit it from the others
+* When issues arise, any member who needs help will communicate these issues through meetings or chat applications where other team members will address these issues and offer advice.
+#### How the team will resolve conflicts
+  * How we will reach consensus when there are disagreements on direction
+    * All team members will sit down in a meeting and discuss the different directions, brainstorm other options which could incorporate these multiple ideas, and ultimatley have a majority vote on the desired direction.
+* What to do when a member is failing to deliver on their obligations to the team
+    * The team should discuss with this member to find out the reason for this issue, and if the issues cannot be resolved, the team will go to management to discuss a better option.
+* How quickly team members are expected to respond to messages directed at them
+    * Team members are expected to respond to messages directed at them the same day the message is sent.
+
+
+### Sprint cadence
+* 2 weeks per sprint
+
+### Daily standups
+* Standups will occur on the following days: (Based off of the class schedule)
+    * 10/13/2022
+    * 10/20/2022
+    * 11/01/2022
+    * 11/03/2022
+    * 11/08/2022
+    * 11/15/2022
+    * 11/17/2022
+    * 11/22/2022
+
+* The time in which the the standups will occur will be discussed amongst the team members through a chat application
+* The standups will last for 15 mintues.
+
+* All members should attend.
+* Members who do not make any progress for two standups or more will be reported to management. 
+
+### Coding standards
+* Visual Studio Code will be the designated code editor.
+* ESLint will be the designated code linter.
+* Prettier will be used for formatting.
+* Write self documenting code.
+* Commented code should be deleted.
+* Make small commits per bug or feature fix.
+* Offer meaningul commit messages.
+* All code must be working before being pushed, and the one who breaks the build must fix it.
+* Code submitted for each task and spike must be reviewed by a peer and pass all tests before being merged into the main branch.
+
+## Git workflow
+The MealHub team uses a feature branch workflow.  Developers will have access to two repositories: 
+* a centralized remote repository (Github repository) accessible by all team members
+* a local clone of the remote repository
+
+
+## How to make a contribution
+* Clone this remote repository on GitHub to your local machine.
+* Before making any changes, pull from the shared central repository to download the latest code.
+* Create a new local branch and switch to it. Name the branch based off the user story, task, or spike associated to the changes that you plan to make.</br></br>
+    * Here is an example for a Task with identification number 4 belonging to a User Story with identificaation number 2:</br>
+`git checkout -b user-story/2/task/4/implement-user-signup`</br></br>
+* Update the task board in GitHub for this sprint by moving the card for this Task or Spike to the applicable "In Process" column.
+* Make your changes locally and commit those changes to the local branch.  
+* Download the latest code from the master branch of the shared central repository, and merge it into the local feature branch and resolve any existing conflicts.
+* Push the feature branch to the shared remote repository.
+* You must issue a Pull Request to other teammates, asking that they accept the changes into the `master` branch.
+* Update the task board in GitHub by moving the card for this Task or Sprint to the relevant "Awaiting Review" column.
+## Rules of contributing
+* Submit only relevant and appropriate code 
+* Touch only the necessary files related to the Tasks or Spikes you are working on 
+* Do not leave Tasks or Spikes unmerged with the master branch for more than two days.
+* Make sure your code is clean following the coding standards listed here: [Coding standards](#coding-standards)
+* Be descriptive in your PR.
+
+
+
+

README.md

@@ -1,20 +1,119 @@
-[![Open in Visual Studio Code](https://classroom.github.com/assets/open-in-vscode-c66648af7eb3fe8bc4f294546bfd86ef473780cde1dea487d3c4ff354943c9ae.svg)](https://classroom.github.com/online_ide?assignment_repo_id=8972803&assignment_repo_type=AssignmentRepo)
-# Project Repository
+[![Front End CI](https://github.com/agiledev-students-fall2022/final-project-team-mealhub/actions/workflows/front-end.yml/badge.svg)](https://github.com/agiledev-students-fall2022/final-project-team-mealhub/actions/workflows/front-end.yml)
 
-This repository will be used for team projects.
+[![Back End CI](https://github.com/agiledev-students-fall2022/final-project-team-mealhub/actions/workflows/back-end.yml/badge.svg)](https://github.com/agiledev-students-fall2022/final-project-team-mealhub/actions/workflows/back-end.yml)
 
-Several sets of instructions are included in this repository. They should each be treated as separate assignments with their own due dates and sets of requirements.
+# MealHub
 
-1. See the [App Map & Wireframes](instructions-0a-app-map-wireframes.md) and [Prototyping](./instructions-0b-prototyping.md) instructions for the requirements of the initial user experience design of the app.
+Live Url: [Mealhub](https://mealhub.vercel.app)
 
-1. Delete the contents of this file and replace with the contents of a proper README.md, as described in the [project setup instructions](./instructions-0c-project-setup.md)
+## Product Vision Statement
 
-1. See the [Sprint Planning instructions](instructions-0d-sprint-planning.md) for the requirements of Sprint Planning for each Sprint.
+An application that allows you to meet new people and enjoy the restaurant down the street you have been dying to try.
 
-1. See the [Front-End Development instructions](./instructions-1-front-end.md) for the requirements of the initial Front-End Development.
+## More about the project
 
-1. See the [Back-End Development instructions](./instructions-2-back-end.md) for the requirements of the initial Back-End Development.
+We will group you with others looking to go to the same restaurant. By going as a larger group, you will be able to meet new people.
 
-1. See the [Database Integration instructions](./instructions-3-database.md) for the requirements of integrating a database into the back-end.
+Each user has the ability to either create a room for a specific cuisine, or join an existing one. Once a room has reached the desired number of people that is set by the creator of the room, the room closes. The time and date are also set.
 
-1. See the [Deployment instructions](./instructions-4-deployment.md) for the requirements of deploying an app.
+## Core Team members
+
+-   Gomda, Abdul Samad| <a href="https://github.com/asgomda">GitHub</a></br>
+
+-   Badr| <a href="https://github.com/ubadr">GitHub</a></br>
+
+-   Kalavadiya, Dev| <a href="https://github.com/Dev-Kalavadia">GitHub</a></br>
+
+-   Hamdani Hussain, Hassan| <a href="https://github.com/hassanhamdani"> GitHub</a></br>
+
+-   Seo, Misha| <a href="https://github.com/mishaseo"> GitHub </a>
+
+## Project History
+
+Being part of the billions of people who enjoy hanging out with others and eating, we wanted to find an easier way to coordinate this favorite pastime of ours. Originally, we discussed and agreed on the fact that meeting new people nowadays has become very difficult, so we thought to ourselves, "Why not create an application where you can meet new people?". However, being the foodies we are, we also considered creating an application where we could find local good eats. Then the magic happened, and we realized that we should combine the two, since finding people to eat with can be difficult, and sometimes going alone to new places to eat can be a bit boring or lonely, but more importantly sometimes the best bonds can be made over a good meal. These ideas ultimately led to the creation of MealHub.
+
+## Environment Variables
+
+To run this project, you will need to add the following environment variables to your .env file
+
+#### Backend:
+
+`PORT=3001`
+
+`NODE_ENV=development`
+
+`MONGO_URI=mongodb+srv://mealhub12345:[email protected]/?retryWrites=true&w=majority`
+
+`JWT_SECRET="catdog"`
+
+`HEADER_URL=http://localhost:3000`
+
+`CLOUDINARY_CLOUD_NAME=asgomda`
+
+`CLOUDINARY_API_KEY=681632229379417`
+
+`CLOUDINARY_API_SECRET=77uyU1Xp2Kek_gOVvFWPgzlrXX4`
+
+`CLOUDINARY_URL=cloudinary://681632229379417:77uyU1Xp2Kek_gOVvFWPgzlrXX4@asgomda`
+
+#### Frontend:
+
+`PORT=3000`
+
+`REACT_APP_URL=http://localhost:3001`
+
+## Run Locally
+
+Clone the project
+
+```bash
+git clone https://github.com/agiledev-students-fall2022/final-project-team-mealhub.git
+```
+
+Go to the project directory
+
+```bash
+cd final-project-team-mealhub
+```
+
+Install dependencies (in both frontend and backend)
+
+```bash
+cd front-end
+npm install
+```
+
+AND
+
+```bash
+cd back-end
+npm install
+```
+
+Start the server
+
+```bash
+nodemon server
+```
+
+Start the front-end
+
+```bash
+npm start
+```
+
+## Running Tests
+
+To run tests, run the following command
+
+```bash
+npm test
+```
+
+## Contributions
+
+For a guide on contributing, please reference <a href="https://github.com/agiledev-students-fall2022/final-project-team-mealhub/blob/master/CONTRIBUTING.md">CONTRIBUTING.MD</a>
+
+## Other information
+
+Check back at a later time for any updates!