From 0832eaded8b140a687c604169d74c34ddb38f756 Mon Sep 17 00:00:00 2001 From: KerissaGit Date: Wed, 26 Mar 2025 18:31:26 -0400 Subject: [PATCH] Added and Formatted README --- README.md | 63 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 40 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 22837bbad..8f6cbec36 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,46 @@ -🍹🍺 The Thirsty Python Bar 🥃🍸 -Welcome to The Thirsty Python Bar! 🍻 This terminal-based drink ordering simulator allows you to simulate your experience at a bar, all through a Command-Line Interface (CLI) powered by Python. Whether it's your birthday or you're just looking to grab a drink, this project offers an interactive way to place drink orders, manage customer tabs, and celebrate special occasions — all while keeping track of orders with an SQL database. - -🎉 Features 🎉 -🙋 Customer Creation: Create a customer profile and verify if they are old enough to enter the bar. -🥳 Birthday Fun: Celebrate your birthday and automatically update your age when you do. -🍹 Drink Management: Add, remove, and select drinks from the menu. -💳 Tabs: Track the drinks a customer has ordered. Open a new tab, view previous orders, and switch between tabs. -💵 Tab Closure: Once the customer has closed their tab, all their orders are removed from the system, and the customer is logged out. -💾 SQL Backend: The system uses an SQL database to store, update, and retrieve customer and drink data. - -💻 Technologies Used 💻 -* Python: The core programming language for logic and CLI interaction. -* CLI: Command Line Interface for interaction with the system. -* SQL: Database management to store customer profiles, drink menus, and order data. - -💾 Starting the Program 💾 +# 🍹🍺 The Thirsty Python Bar 🥃🍸 + +Welcome to **The Thirsty Python Bar**! 🍻 This terminal-based drink ordering simulator allows you to simulate your experience at a bar, all through a Command-Line Interface (CLI) powered by Python. Whether it's your birthday or you're just looking to grab a drink, this project offers an interactive way to place drink orders, manage customer tabs, and celebrate special occasions — all while keeping track of orders with an SQL database. + +--- + +## 🎉 Features 🎉 + +- 🙋 **Customer Creation**: Create a customer profile and verify if they are old enough to enter the bar. +- 🥳 **Birthday Fun**: Celebrate your birthday and automatically update your age when you do. +- 🍹 **Drink Management**: Add, remove, and select drinks from the menu. +- 💳 **Tabs**: Track the drinks a customer has ordered. Open a new tab, view previous orders, and switch between tabs. +- 💵 **Tab Closure**: Once the customer has closed their tab, all their orders are removed from the system, and the customer is logged out. +- 💾 **SQL Backend**: The system uses an SQL database to store, update, and retrieve customer and drink data. + +--- + +## 💻 Technologies Used 💻 + +- **Python**: The core programming language for logic and CLI interaction. +- **CLI**: Command Line Interface for interaction with the system. +- **SQL**: Database management to store customer profiles, drink menus, and order data. + +--- + +## 💾 Starting the Program 💾 + To get started, first clone the repository: - git clone git@github.com:Ketchuso/python-phase3-project.git - cd python-phase3-project + +- git clone git@github.com:Ketchuso/python-phase3-project.git +- cd python-phase3-project + Make sure you have Python installed (version 3.7 or above). + To start the application, open your terminal and run the following command: - python lib/cli.py -🙏 Acknowledgments 🙏 -A huge thank you to the talented developers who contributed to this project Jay, Victoria and Kerissa +- python lib/cli.py + +## 🙏 Acknowledgments 🙏 + +A huge thank you to the talented developers who contributed to this project: +Jay, Victoria, and Kerissa + +## 📜 License 📜 -📜 License 📜 This project is licensed under the MIT License. \ No newline at end of file