Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 5.32 KB

README.md

File metadata and controls

72 lines (47 loc) · 5.32 KB

Supp2U Front End Repo

[dev]

Website

https://supp2u.netlify.com/

Netlify Status

Contributors

Amber Meador Taylor Blount Zechariah Drinkhall Julian Jay Kohlman Henry Neal Sibhat Temelso Laryna Billinghurst

Project Overview

Our goal is to build an application that will bring restaurants, and customers together by allowing businesses to showcase and advertise their delectable creations, while allowing customers to benefit from each others shared experiences via reviews, and ratings.

Key Features

* Integrate with Google maps allowing users an easy to find a nearby restaurant 
* Users can order from a restaurants online menu
* Business owners can create an account and have their establishment appear on our map
* Business owners can create online menus
* Customers can leave reviews and ratings on businesses
* An integrated payment system so users can checkout on our site

Front End Tech Stack

* react
* node-sass
* react-redux
* yarn
* axios
* auth0
* enzyme
* moment
* react-router-dom
* react-spring
* react-stripe-elements
* react-toastify
* reactjs-popup
* reactstrap

Installation Instructions

Install all dependencies by running yarn install

Other Scripts

* build - `yarn build`
* start - `yarn start`

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  REACT_APP_GOOGLE_MAP_API_KEY - this is your Google API key, which can be generated in the Google Cloud Console
*  REACT_APP_GCOORDINATES - this is your Google API key, which can be generated in the Google Cloud Console

To connect to our backend api, if you want to connect to our deployed server

* REACT_APP_BACKEND_URL=https://supp2udev.herokuapp.com/

OR if you are launching it yourself after downloading our backend

* REACT_APP_BACKEND_URL=http://localhost:3001/api/v1/