mary-brooks / mixguide

Mix Guide is a user-friendly web application designed to assist cocktail enthusiasts in discovering and creating delicious drinks based on their available ingredients. Developed as part of a web development course, Mix Guide aims to simplify the cocktail-making process while inspiring creativity in mixology.

🍹 Table of Contents

• Demo
• Features
• Technologies
• Getting Started
• Usage
• Contributing
• License

🌐 Demo

Check out the live demo here

🌟 Features

• Ingredient-based Cocktail Recipes: Discover cocktail recipes based the ingredients you have at home.
• Customizable Drink Lists: Create personalised drinks lists to save and share your favorite cocktail recipes.
• Daily Featured Cocktail: Explore a new featured cocktail every day for inspiration.
• User-friendly Interface: Intuitive design for seamless navigation and user experience.
• Advanced Filtering Options: Filter recipes by cocktail type, dietary restrictions, and sorting preferences.

⚡️ Technologies

This project is built using the following technologies:

• React
• JSON Server

🚀 Getting Started

Prerequisites:

• Ensure that you have Node.js installed on your machine. You can download it here.

Step-by-Step Guide:

1. Clone the Repository:

   • Open your terminal or command prompt.

   • Run the following command to clone the repository:

     git clone https://github.com/mary-brooks/mixguide.git

2. Navigate to the Project Directory:

   • Change into the project directory:

     cd mixguide

3. Install Dependencies:

   • Install the project dependencies using the following command:

     npm install

4. Run the Application:

   • Start the development server with the following command:

     npm run dev

   • This will launch the application in your default web browser. If not, you can access it by navigating to http://localhost:3000/ in your browser.

5. Explore Mix Guide:

   • Once the application is running, you can explore the Mix Guide features locally.

👩‍💻 Usage

• Select Ingredients: Choose your ingredients from our fridge, pantry, and cupboard.
• Discover Recipes: Explore cocktail recipes generated based on your selected ingredients.
• Customize Lists: Save your favorite recipes to personalised drinks lists.
• Share and Enjoy: Share your curated drink lists with friends and fellow cocktail enthusiasts.
• Advanced Filtering: Use the advanced filtering options to refine your search by cocktail type, dietary restrictions, and sorting preferences.

🤝 Contributing

Contributions are welcome! If you have ideas for improvements or new features, please open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License, which means you are free to use, modify, and distribute the code.