Restaurateur

Description

Welcome to our Group Project 03 -- Restaurateur! Starting a restaurant can be a bit daunting. Our instruction app offers you a Step-by-Step Guide to Opening a Restaurant in New York City.

After logging in, our app can help you with best practices and resources! Numerous available resources such as Permits, Certifications, and Posters all at your finger tip, which will help you get your restaurant up and running, and ensure you to pass local DOH inspection. You will be on your way to successfully opening your dream restaurant!

Table of Contents

• Description
• User Story
• Acceptance Criteria
• License
• Technologies Used
• Installation
• Usage
• Restaurateur - Deployed Application
• Restaurateur - Github Repository
• Team Members - How to reach us!
• Questions / Inquiry
• Screenshots

User Story

AS A user interested in opening a restaurant New York City.

I WANT an application that will provide resources and instructions on how to do so.

SO THAT I can access all the necessary materials to open up a restaurant in one App.

Acceptance Criteria

OUR project fulfilled the following requirements:

Use React for the front end.

Use GraphQL with a Node.js and Express.js server.

Use MongoDB and the Mongoose ODM for the database.

Use queries and mutations for retrieving, adding, updating, and deleting data.

Be deployed using Heroku (with data).

Have a polished UI.

Be responsive.

Be interactive (i.e., accept and respond to user input).

Include authentication (JWT).

Protect sensitive API key information on the server.

Have a clean repository that meets quality coding standards (file structure, naming conventions, best practices for class and id naming conventions, indentation, high-quality comments, etc.).

Have a high-quality README (with unique name, description, technologies used, screenshot, and link to deployed application).

License

This project is licensed under the MIT.

Technologies Used

• Javascript
• HTML5
• CSS
• MongoDB Atlas
• Heroku
• NPM Apollo Client Package
• NPM Apollo-Server-Express Package
• NPM GraphQL Package
• NPM JSONWebToken
• NPM Mongoose Package
• Node.js
• NPM nodemon Package
• NPM React Package
• NPM React-Bootstrap
• React-Dom
• React-Router-Dom
• React-Scripts

Installation

To install this application, clone the code into your terminal for the respective repository.

Run the following commands in the command-line in the root of the folder:

1. Run npm i to install all the packages.
2. npm start runs the app in development mode.
3. npm run build creates a build directory with a production build of your app.
4. npm run develop Your app is ready to be deployed!

Usage

1. When the user is NOT logged in, there are only two options on the navigation bar. Users who have not signed up need to register their name, email, and password to log in. Users who have signed up before can choose to log in directly.
2. When a user is logged in, they are presented with options on the navigation bar, each featuring Certifications, Permits, Posters, Contact and logout.
3. When a navigation title is clicked, the user is presented with the corresponding section below the navigation without the page reloading.
4. User can use the navigation bar to navigate through different sections for their actual needs.
5. Once user enter each section, they can see the credentials required to open a restaurant under different categories.
6. When a user clicks on 📖 document icon, the page will link to the download page for the material they actually need.
7. When a user clicks on arrow icon, the page will link to the page for more information.
8. Users can leave their contact information and message on the contact page.
9. When a user clicks on the Logout button, then they are logged out of the site and presented with a homepage with the website introduction Login/Signup option button.

Restaurateur - Deployed Application

https://intense-ravine-89236.herokuapp.com/

Restaurateur - Github Repository

https://github.com/Muzan67/restaurateur

Team Members - How to reach us!

• https://github.com/Shuyu-Sun - Shuyu Sun
• https://github.com/Yahplee - Andrew Lee
• https://github.com/randiferous - Daniel Lee
• https://github.com/jonrosenblum - Jon Rosenblum
• https://github.com/Muzan67 - Alejandro Cortez

Questions / Inquiry

The Github page for this project can be accessed using the following link: https://github.com/Muzan67/restaurateur

If you have any questions about this projects, please find below our emails:

• [email protected] - Shuyu Sun
• [email protected] - Andrew Lee
• [email protected] - Daniel Lee
• [email protected] - Jon Rosenblum
• [email protected] - Alejandro Cortez

Screenshots of Restaurateur

Landing Page - App Introduction

Log-in

Sign-Up

Certifications

Permits

Posters

Contact-Us