Skip to content

This is a mobile friendly app which allows users to access a library of available cocktails with their name, instructions and ingredients.

License

Notifications You must be signed in to change notification settings

SepidehAyani/mixitup

Repository files navigation

Mix-It-Up

This is a mobile friendly app which allows user to make new beverages based on supplies available in their household.

GitHub last commit GitHub code size in bytes GitHub watchers GitHub top language GitHub license

User Story

The user can access a list of alcoholic and non-alcoholic drinks, with their name, pictures, instruction of how to make them and the used ingredients. The user also can choose a favorite drink and add it to their My Favorite Drinks list after they are logged in.

Table of Contents

  1. About the Project
  2. Project Links
  3. Screenshots
  4. Installation
  5. Usage
  6. Project Team
  7. Questions
  8. License

About The Project

  • When user opens the mix-it-up app, they are presented with the homepage, which includes existing list of drinks if any have been posted; navigation links for the homepage and the dashboard; and the option to log in.
  • When user clicks on the homepage option, they are taken to the homepage.
  • When user chooses to sign up, they are prompted to create a username and password.
  • When user clicks on the sign-up button, the user credentials are saved and user is logged into the site.
  • When user revisits the site at a later time and choose to sign in, they are prompted to enter my username and password.
  • When user is signed in to the site, they can see navigation links for the homepage, the dashboard, and the option to log out.
  • When user clicks on the homepage option in the navigation, they are taken to the homepage and presented with existing drinks that include the name of the drink, and photo of the drink.
  • When user clicks on an existing drink, they are presented with the drink name, instruction, ingredients and photo of a drink, and date created for that drink and have the option to leave a comment.
  • When user enters a comment and clicks on the submit button while signed in, the comment is saved and the post is updated to display the comment, the comment creator’s username, and the date created.
  • When user clicks on the dashboard option in the navigation, they are taken to the dashboard and presented with any drinks that have already created and the option to add a new drink.
  • When user clicks on the rating stars, they are able to give a rating to a drink.

Project Links

Repo Link
Deployed Project

Screenshots

Project Preview

Instructions

git clone https://github.com/SepidehAyani/mixitup.git
In the root directory of the project, run 'npm i' to download the dependencies.
Initiate the database with 'mysql -u root -p'.
To create tables, run 'source db/schema.sql'.
Exit the mysql terminal, and run 'npm run seed' to insert data into the tables.
Run 'npm start' to start your server.

Make sure to add a .env file to the root of the app with the following details:

DB_NAME='mixitup'
DB_USER='user'
DB_PW='xxx'

Languages and libraries used in this project:

Usage

Mix-It-Up allows users to:

  • sign-up, login, and logout.
  • see a list of available drinks with their names, instructions and ingredients.
  • see a list of favorite drinks and add to the list.

Questions

Contacts claire.rosenfrisk@gmail.com
kevin_wilde564@yahoo.com
sepid.ayani@gmail.com

Project Team

Claire Rosenfrisk
Kevin Wilder
SepidehAyani

License

Distributed under the MIT License. See Choose A License for more details.

About

This is a mobile friendly app which allows users to access a library of available cocktails with their name, instructions and ingredients.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •