Project Repository

Deployed Code Link:

http://161.35.75.193:3000/

About this Project:

This repository will be used for team projects.

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.

1. See the App Map & Wireframes and Prototyping instructions for the requirements of the initial user experience design of the app.

2. Delete the contents of this file and replace with the contents of a proper README.md, as described in the project setup instructions

3. See the Sprint Planning instructions for the requirements of Sprint Planning for each Sprint.

4. See the Front-End Development instructions for the requirements of the initial Front-End Development.

5. See the Back-End Development instructions for the requirements of the initial Back-End Development.

6. See the Database Integration instructions for the requirements of integrating a database into the back-end.

7. See the Deployment instructions for the requirements of deploying an app.

Project Description:

This application will allow users to rate individual items at restaurants. There are two current problem with review systems like Google Reviews (which is excellent) and Yelp: (1) you can rate restaurants but not individual food items, and (2) people don't know what's "the best" thing to order at a restaurant unless by word of mouth. On the first point, critically, things such as service and ambience will lower the overall rating of the restaurant even if the food is fire (delicious). Our application solves this problem by focusing our ratings exclusively on the dishes themselves. On the second point, our application enables users, before going to or at a restaurant, to quickly lookup the best-rated items. Our target market is foodies and those with allergies.

In 2 months we want this project to be fully functional.

Team Members:

Akhil Kotamraju: Github & LinkedIn

Christina Borao: Github & LinkedIn

James Galbraith: Github & LinkedIn

Janak Balar: Github & LinkedIn

Wei Luo: Github & LinkedIn

Project History:

This application idea was the creation of five excited foodies. We bonded on the shared experience of craving a dish but not knowing which restaurant serves the best version of that dish. We are solving this issue through our application!

Project contributions should be made with the following guidelines in mind.

Instructions for Building and Testing:

PRIOR TO MAKING ANY PUSH REQUESTS: make sure to enter the command 'git pull' into your terminal, then stage your changes and push your code with a detailed message regarding the changes made.

1. Create a well-defined strategy to tackle the feature being built.
2. Analyze and anticipate potential issues in the code.
3. Run 'git pull'. Code the back-end/server technology (run a code review and push process periodically).
4. Have a teammate check your code!
5. Run 'git pull'. Create the application programming interface.
6. Have a teammate check your code!
7. Run 'git pull'. Develop the mobile app front-end or "client-side" interface (run a code review and push process periodically).
8. Developer requests a review of the code.
9. Run documentation testing.
10. Run functional testing (business functionality, target audience, and distribution channels).
11. Run usability testing (satisfaction, efficiency, effectiveness).
12. Run User interface testing.
13. Run compatibility testing (OS Configuration, Browser Configuration, Database Configuration, Device Configuration, Network Configuration).
14. Run performance testing (Load Testing, Stress Testing, Stability Testing, Volume Testing, Concurrency testing).
15. Run security testing.
16. Run certification testing.

Additional Markdown Documents

Instructions on how to set up and run the project, this process will require two terminals:

1. Open a new terminal
2. In terminal (1), cd front-end
3. In terminal (1), enter 'npm run start'
4. Open a new terminal
5. In terminal (2), cd back-end
6. In terminal (2), enter 'nodemon'
   1. If an error is displayed after entering 'nodemon' in terminal (2)...
   2. In terminal (2), enter 'sudo npm install -g nodemon'
   3. If prompted in terminal (2), enter computer password
   4. In terminal (2), enter 'nodemon'

The front-end will run on port 3000, while the server will run on port 3002.

After starting up the application...

• If you would like to access the application... press here
• If you would like to access the data taken in from "Add Restaurant" in the back-end server... press here

To view tests status and code coverage:

1. Open a new terminal
2. In terminal, cd back-end
3. In terminal, enter 'npm test'
4. Allow time to run and view results

Additional Information

Restaurant Item Rating Project - Additional Information