brandonvicc / yelp-clone

Yalp!

General Description

Yalp! is a platform for people to promote how well kept their businesses are by recieving great reviews left by people who attended their businesses. Businesses can recieve good or bad reviews depended on how well they take care of their customers. Yalp! gives basic information about a business so people can try out new businesses or businesses who are trending with good reviews. Viewing reviews has become an absolute go-to when attending new businesses so why not check out Yalp!

Frontend Overview

React

Yalp!'s frontend logic is carried by React. Yalp is a React application at its core.

Redux

Yalp! uses Redux to manage its state during the users experience of the app.

Backend Overview

Express

Yalp! uses an express api to store information about users, businesses, and reviews. Which can be retrieved by Redux and displayed by React.

PostgreSQL

Yalp! uses PostgreSQL as the database because of it reliability and ease of use with deployment.

Sequelize

Yalp! has Sequelize integrated as the ORM. Sequelize makes interacting with the database throughout the app really easy.

S3

Yalp! utilizes S3 so users can add files from their computer.

Features

Business

Create / Read

Edit / Delete

Reviews

Create / Read

Edit / Delete

Likes

Create / Delete

Search

Installation

Clone the repo

git clone https://github.com/brandonvicc/yelp-clone.git

Install dependencies from the root directory.

cd frontend > npm install
cd backend > npm install

Create a POSTGRESQL user with CREATEDB and PASSWORD in PSQL.

  CREATE USER <name> WITH CREATEDB PASSWORD <'password'>

Create a .env file base on the .env.example given in the backend folder

Enter your username and password information into you .env file along with your desired database name, a secured combination of characters for your JWT_SECRET, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, Google Maps Api MAPS_API_KEY and your desired PORT (preferably 5000).

Add the following proxy to your package.json file with your front end directory, replacing or keeping the 5000 port to match your PORT configuration found in your .env file.

  "proxy": "http://localhost:5000"

Create Database, Migrate, and Seed models.

  npx dotenv sequelize db:create
  npx dotenv sequelize db:migrate
  npx dotenv sequelize db:seed:all

Start the services in the back end directory.

  npm start

Start the services in the front end directory, which should open the project in your default broswer. If not naviagte to http://localhost:3000

  npm start