STAR YELP

A portfolio clone of Yelp: https://www.yelp.com/ in the style of RSI Website: https://robertsspaceindustries.com/

Explore the site »

Explore the docs »

Table of Contents

1. About The Project
2. Key Features
3. Frontend Overview
4. Backend Overview
5. Star Yelp Setup
6. Usage
7. Future Implementations
8. Contact

About The Project

Star Yelp, a Yelp clone, is a business/service review website for users to share their listing information with other site users, and also provide feedback in the form of reviews and ratings for listings posted by other users, all in the expansive world of the video game "Star Citizen". Users have the ability to edit and delete their listings after posting, and they can also edit and delete their reviews/ratings. With Star Yelp, say goodbye to wasting precious quantum fuel jumping around the 'verse to meet your best needs, check the reviews then save time and energy!

Key Features

• Create new users and have user login with authorization
• Once logged in, view all listings & reviews across the site posted by all users
• Post new listings then edit and delete them later if required
• Post new reviews on other listings then edit and delete them later if required

(back to top)

Frontend Overview

Star Yelp is built on a React frontend and uses an npm package for displaying ratings as stars.

Technologies/Frameworks Used

• Javascript
• React
• Redux
• HTML
• CSS
• react-rating-stars-component

Backend Overview

Star Yelp uses a Flask backend and utilizes PostgreSQL as its database. It also uses wtfforms as a form package.

Technologies/Frameworks Used

• Python
• PostgreSQL
• Flask
• Wtfforms
• SQLAlchemy

The live site is hosted on Render.

• Render

(back to top)

Star Yelp Setup

1. Clone the repository from: https://github.com/suwanshree/star-yelp.git

2. Install dependencies:

   pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt

3. Create a .env file based on the example with proper settings for your development environment.

4. Setup your PostgreSQL user, password and database that matches the .env file.

5. Get into your pipenv, migrate your database, seed your database, and run your flask app:

   pipenv shell

   flask db upgrade

   flask seed all

   flask run

6. To run the React App in development, checkout the README inside the react-app directory.

Usage

• Users can signup and login to use Star Yelp, and can also use the demo feature to explore the website quickly.

• Once logged in, the user is directed to the listings page, where logged-in users can view a list of all the listings in the website, search for a particular listing by title, and sort the listings by desired category.

• Logged in users can create a new listing. It can also be edited and deleted. Users can also view their own listings in their profile page.

• Logged in users can click into any individual listing, to enter the single listings page and view all the reviews associated with it.

• Once in the single listing page, logged in users can add their own review, if it is not a listing owned by them. Here they can also edit and delete their own review. To be fair to listing owners, users have a limit of one review per listing.

(back to top)

Future Implementations

• Search Feature - Users can search all listings by providing keywords through a search bar. ✅
• Feedback - Users can provide feedback through a form that sends an email to the site administrator.
• AWS Images - Users can upload multiple images for listings and reviews from their local machine. ✅
• O-Auth integration - Users can choose to login via their google accounts through O-Auth authentication.
• Listing Categories - Listings have categories associated with them which users can filter the main listings page by. ✅
• Expanded User Profiles - User profiles are expanded to show all of the logged in user's listings in one place. ✅

Contact

Suwanshree Acharya - GitHub

Project Repo Link: https://github.com/suwanshree/star-yelp

Project Link: https://star-yelp.onrender.com

(back to top)