Skip to content

crystalcrandall92/Cocktail-Me

Repository files navigation

Cocktail Application

License

MIT License (https://choosealicense.com)

Table of Contents

  1. Description
  2. Installation
  3. Usage
  4. Contribution
  5. Test
  6. Credit
  7. Questions & Contact

Description

Cocktail Application is an application that allows a user to explore a database of cocktails and create their own drinks. This application also enables a user to create an account and save their collection of cocktails. Cocktail Application is a platform to demonstrate what our team has learned in class up to this point, and is the first full-stack application we have built on our own. Initially, our team had the idea to build something a little more complex: a Petfinder application with slightly more sophistication and features than the existing Petfinder. However, we found that this was too ambitious after running into some authentication troubles with the Petfinder API. So, we pivoted to a slightly simpler concept that would allow us to focus on the meat of the code.

Installation Instructions

To install this project on your local machine, enter your MySQL information in the config.json file and then run npm install for all the necessary packages. The server should be listening on port 8080. To deploy this application via Heroku, simply click the link provided to be taken to the webpage.

Usage Information

To navigate Cocktail Application, begin at the home page. This page is an introduction to the application that contains information about its functionality and the collaborators. In the navigation bar at the top of the page, there are several tabs: Search Drink, Create Drink, Your Drinks, and Login or Sign Up. In the Search Drink tab, there are two different fields available for you to enter either a drink name or drink ingredient. Simply click on the magnifying glass icon to search our database for a match. In order to create your own drink in the Create Drink tab, you must make an account by navigating to the sign up page. Then, you can enter a recipe for your own drink. There are fields for spirits, other ingredients, and directions (shaken, stirred, garnishings, et cetera). Click the create button at the bottom of the page to add this recipe to the "Your Drinks" tab. In this tab, a list of the drinks you have created or saved will store locally on your machine. Last, you can either log into an existing account or create a new account under the Log In or Sign Up tab.

Contribution Guidelines

See contact information

Test Instructions

Run "node server"

Credit

Trilogy Education Services https://www.thecocktaildb.com/ https://bootstrapious.com https://getbootstrap.com/ https://unsplash.com https://mdbootstrap.com https://w3schools.com https://stackoverflow.com/

Questions and Contact Information Below

Github Username: crystalcrandall92, evanwmotte, carolinem15

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published