miacias / brew-buddies

Brewery social media site for writing reviews, finding places, and finding friends!

Home Page:https://fierce-basin-42875.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Brew Buddies

Description

Brew Buddies is a hybrid review site and social media for lovers of beer, breweries, barley, and buddies. This application allows you to search nearby breweries and see user reviews, or take up a pen (so to speak) and write your own! You can also add breweries to your Favorites list, so no matter how good a time you have, you'll never forget your favorite hangout hops spots. If a review catches your eye, save it to your favorites so you can try it next Saturday night. You can also add Friends, who you might want to share a pint with. The site display is as fresh and fun as your favorite distillery pull. Please drink responsibly! Cheers! 🍻

Table of Contents

Installation

No installation required! Deployed link here.

Usage

The landing page of the website presents a list of recent brewery reviews. For full functionality, a user with have to sign up and login. Once logged in, users can search breweries by postal code and is presented with a list of breweries in that area and a map display with their locations. A user can click on any brewery's link to see its page. It will display the brewery info, as well as any available reviews and its average star rating. A user can click on the "Add to Favorites" button to save a list of breweries. They can also add a review of their own. Users can also add another user as a friend to see their reviews or favorites. Please see below for screenshots!

Contributors

Roadmap

Content will be added and adjusted as new coding projects are available! Some projects may phase out over time as contrubitors' work becomes more specialized.

  1. user experience:
    • users can save breweries to their wishlist for future travels and exploration
  2. site quality:
    • add validators on sign up for birthdate (ages 21 and up!)
    • display total number of reviews and average rating on single brewery page
    • custom Ant Design Theme using craco
    • maximize homepage OpenBreweryDB API call and incorporate pagination
  3. future feature(s):
    • cocktails
      • search cocktail recipes with names, ingredients, and instructions through api-ninjas.com/api/cocktail
      • users can save favorite cocktail recipes
      • users can save custom cocktails
    • interaction
      • user actions save to profile feed where friends can add "likes" and/or "comments"
      • add geolocation tools to promote local micro breweries, distilleries, etc.

Credits

Documentation referenced:

U. Penn Bootcamp instructor(s):

Tutor(s):

  • Alexis San Javier GitHub
    • making use of client-side auth utils and storing in state variable
    • rendering user review to Single Brewery page
  • ChatGPT - basic debugging

Tutorials referenced:

  • Tim Mousk - get element by ID with React useEffect

Artist(s):

Technologies & Tools used:

  • VS Code
  • React
  • GraphQL, Node.js, Express.js, Apollo
  • MongoDB, Mongoose
  • Bcrypt, JWT, Dotenv
  • Ant Design, Granim.js
  • BSON
  • Heroku
  • Google Maps API
  • Open Brewery DB API

License

Please refer to the LICENSE in the repo:

License

Features

  • Search breweries by postal code
  • See user reviews on each brewery
  • Write a review with a star rating
  • Add breweries to a favorites list
  • Add and remove friends
  • View user profiles with their reviews

Screenshots

Home Page with Reviews Brewery Search Map Display Brewery Page

About

Brewery social media site for writing reviews, finding places, and finding friends!

https://fierce-basin-42875.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 96.5%Language:CSS 2.1%Language:HTML 1.4%