Skip to content

Commit

Permalink
final readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seagda committed Jan 6, 2021
1 parent 32834d0 commit 366e0d6
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 25 deletions.
Binary file added Presentation-TheFullTankard.pdf
Binary file not shown.
47 changes: 22 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@


## DESCRIPTION
Introducing "The Full Tankard", an streamlined web application, allows bar managers to find information about local beers and breweries in Washington State.
Introducing "The Full Tankard": a free, streamlined, fully responsive web application that allows bar managers to find and save information about local beers and craft breweries in the Pacific Northwest (and beyond) without leaving the floor, built in JQuery, CSS, and HTML on top of the Materialize framework.

---------
## DEPLOYED APPLICATION, RELEASE 1.0
View the deployed application: [https://seagda.github.io/the-full-tankard/].

---------
## USER STORY
Expand All @@ -16,33 +20,23 @@ Also, AS A bar manager,
I WANT a directory of brewers by name with styles of beer brewed and contact information
SO THAT I can locate and procure local beers from brewers that my customers might enjoy at my bar.

---------
## OUR SOLUTION
* Kanban board
* The Pitch: Why our app?
* Our MVP vs Product Vision
Also, AS A bar manager,
I WANT current news and events regarding craft beer and breweries
SO THAT I can understand trends in the industry.

---------
### TECHNOLOGIES UTILIZED
* Materialize for our CSS framework
* APIs: currently using
* UI Framework: Materialize []
* APIs:
* Open Brewery [https://www.openbrewerydb.org/documentation/01-listbreweries]
* Beer.db [https://openbeer.github.io/]
* Brewerydb.com [https://www.brewerydb.com/developers/docs]

* APIs for Ratings/Social media: TBD
* The Beer Spot [http://www.thebeerspot.com/api/reference]
* Ratebeer.com [https://www.ratebeer.com/api-documentation.asp]

---------
## ACCEPTANCE CRITERIA
GIVEN ...
AS A ...
WHEN ...
THEN ...
* Open Beer Database [https://data.opendatasoft.com/explore/dataset/open-beer-database%40public-us/table/]
* Contextual Web Search [https://rapidapi.com/contextualwebsearch/api/web-search]
* Google Maps [https://cloud.google.com/maps-platform/]
* Photography courtesy of Unsplash [https://unsplash.com/s/photos/beer]

---------
## VIEW THE MOCKUPS
The following images show the appearance and functionality of our MVP:
## WIREFRAMES
The following images show the original appearance and functionality of our MVP. (Note: search by ABV functionality not available in release 1.0).

### Homepage (browser & phone)
![Homepage demo](assets/img/mock-homepage-TFT.png)
Expand All @@ -51,7 +45,10 @@ The following images show the appearance and functionality of our MVP:
![Beer Results demo](assets/img/mock-beer-results-TFT.png)

---------
## ABOUT THE TEAM
* Rita Z. is our lead UI/UX designer.
## PITCH DECK
![View the slide deck](Presentation-TheFullTankard.pdf)

## DEVELOPER TEAM
* Rita Zhu is our lead UI/UX designer.
* Elias Calagiu is our lead developer.
* Shea Mullaney is our project manager.

0 comments on commit 366e0d6

Please sign in to comment.