MiguelLamas / yelp-clone-pern-stack-frontend

Yelp clone - Frontend (PERN Stack - Postgres, Express, React, and Node)

YELP CLONE - Frontend (PERN Stack - Postgres, Express, React, and Node)

A basic Yelp Clone App built with the PERN stack technologies. The application allows users to add restaurants, their location and price range initially. The user can then add reviews and ratings to each restaurant, as well as update and delete individual restaurants. The app takes into account the ratings provided by users and returns an average ratings score for each one aswell as a total of the number of reviews submitted.

This README is for the Frontend of the Yelp Clone PERN App. If you would like to explore the Backend of the app please go to the Backend repository.

---

Features:

• Add different restaurants
• Add multiple reviews and ratings for restaurants
• Get an average star rating, plus number of reviews available per restaurant
• Update restaurant information
• Delete listed restaurants that you no longer want/need

---

Project Setup & Running:

Backend:

The backend is deployed on ElephantSQL however if you would like to run locally you will need to follow the steps below.

1. Git clone the backend repository by pasting the following into your terminal:

  git clone https://github.com/MiguelLamas/yelp-clone-pern-stack-api

2. Install all required dependencies by running:

  npm i

3. Copy your database (e.g. ElephantSQL) URL into the .env file, following the format:

 DATABASE_URL = <Database URL goes here>

4. Create all tables in your database by running the following scripts in the terminal:

npm run createRestaurantsTable
npm run createReviewsTable

5. To populate the tables you can achieve this by interacting with the front-end, you can either run this locally or host on a hosting platform - for this project I used Render but you are free to choose your own. For assistance deploying on Render please click here.

6. Finally, to run the server locally use the following script within your terminal:

  npm run start

---

Frontend:

To run the front-end locally follow the steps below:

1. Git clone the front-end repository by pasting the following into your terminal:

  git clone https://github.com/MiguelLamas/yelp-clone-pern-stack-frontend

2. Install all necessary dependencies by running the following command in the terminal:

  npm i

3. Start the app using:

  npm run start

---

Tech Stack:

Frontend:

• React.js, JavaScript, HTML, Bootstrap 5

Backend:

• Node.js, Express, PostgreSQL, CORS

Deployed with:

• Render (for API Web Service & Frontend Static Site) and ElephantSQL (for PostgreSQL Database)

---

Developer:

• Miguel Lamas - GitHub

---

License:

Copyright (c) 2023 Miguel Lamas - https://github.com/MiguelLamas

---