Group Full Stack Project (Kelp)

Feel free to explore our website, Kelp, a platform designed to allow users to see reviews about businesses in Bikini Bottom from the iconic show, Spongebob Squarepants! Take a tour of the website and discover a diverse range of restaurants and businesses available at your fingertips. Registered users can explore, create businesses, and leave reviews on Kelp.

Click on the link below to visit the live site!

Languages Used

Site Preview

What can you do on Kelp?

1. Check out reviews and ratings for businesses helping others make informed decisions!

• Navigate through the website as either a registered or unregistered user. Create your own account or simply log in as the demo user for quick access!
• View available businesses and see what other users have to say about it

2. What are the perks of being a registered user?

• Create your own business in Bikini Bottom
• Edit or delete your existing spots
• Other users can leave reviews on your existing spots
• Post reviews on other spots

How to download Kelp on your local computer

1. In the root folder:

• create an .env file

• copy over .envexample content into the new .env file

• run these commands in terminal

  pipenv requirements > requirements.txt
  pipenv install
  pipenv shell
  flask db upgrade
  flask seed all
  flask run

2. cd into the root folder and then run pipenv run flask run to start the back-end

3. cd into the react-app folder and then run npm start to start the front-end

Site Summary

Landing Page

• This page generates three randomly selected reviews to present a brief excerpt written by customers about other businesses

Main Page

• Click the 'View All Spots' link to navigate here
• The homepage displays a comprehensive list of all available locations featured on Kelp.
• This page is also accessible to anyone (registered and unregistered users)

Sign Up

• Unregistered users have the option to create an account through the dropdown menu located at the top-right corner
• In the event a user attempts to input invalid information, error messages will populate to guide the user to resolve them accurately
• Upon successful completion of the Sign Up form, the new user will be logged in automatically

Log In

• Existing users can access their accounts through the designated login portal through the dropdown menu located at the top-right corner
• To gain full access to Kelp quickly, simply click the "Sign In as Demo User" button. This will allow you to creating new business, managing existing businesses, and leave reviews on others' businesses

Leave a Review

• Registered users can submit reviews provided that they have not previously submitted a review for the same spot
• Each review requires a description and star rating, while the inclusion of photos remains optional
• Newly ubmitted reviews dynamically appear on the current page
• Users may modify or delete their reviews conveniently through the business details page

Add a Business

• As a logged-in user, create a spot in Bikini Bottom
• Each new listing requires a name, description, category, price, and image!

Manage Business

• User is able to update or delete the spot on the spot details page
• Each update requires a name, description, category, price, and image!