Skip to content

johnshellabarger/deja-bru

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Deja-Bru

An app that keeps track of the breweries you have been to, which ones are your favorite, and which ones you want to visit!

View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgements

About The Project

deja-bru-landing-page-animation

Do you love Beer? Do you love it so much that you've gone to so many breweries and drank so much beer that you can't remember which one's you've been to and which ones are your favorite? Then you NEED Deja-Bru!

Features of Deja-Bru:

  • Search for Breweries by City or State and find breweries on a map
  • Keep a running list of the breweries you have visited
  • Label breweries as a favorite and leaves comments so you remember why it's your favorite! (Since you forgot after your 6th pint!)

Built With

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/johnshellabarger/deja-bru.git
  2. Install NPM packages
    npm install
  3. Start the JSON server
    json-server --watch db.json
  4. Start the App
    npm start

Usage

Landing Page

Pour yourself a cold one and watch the page do the same! Bubble animations and a golden ale colored background prepare you to remember your favorite breweries!

Searching for Breweries

Click on the home button and you are presented with a map and a search bar. Enter a city or state to being your search for your favorite breweries! Click a beer on the map to see the name of the brewery, and click the find button to display the card for that brewery. Or you can scroll through the list to start your search!

Marking a Brewery as Visited

Click on "Add to Visited" to mark that brewery as visited. Click on the Visited tab to see all of the breweries you have visited!

Visited Tab

On the Visited Tab you can see all of your visited breweries on a map! You can also choose to favorite a specific brewery, rate a brewery 1-5 starts, sort by rating, search by name, and visit the website for that brewery. This is the heart of Deja-Bru! When you can't remember where you've visited and what you rated it, come to this page!

Favorites Tab

On the Favorites Tab you can sort through your favorites by name, or state, as well as search by name. When you click view comments you can see any comments you made about that brewery and add a new comment. You can also remove the brewery from your favorites if they sell out to AB and they start making bad beer!

Roadmap

We recently were approved to use the Untappd API so we hope to use that data as instead of OpenBreweryDB at a later time. We are also looking to add user authentication to this app and create our own back-end for this project.

Contributing

Are you a beer aficionado who also codes? Do you want to contribute to this open-source project with your own ideas? Are you interested in this app and want to make it even better? Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Add and Commit your Changes (git commit -am 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Steve Vaughn - GitHub | LinkedIn | Medium | Twitter | Email

John Shellabarger - GitHub | LinkedIn | Email

Project Link: https://github.com/johnshellabarger/deja-bru

Acknowledgements

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published