Skip to content

Commit 29f58ed

Browse files
authored
Merge pull request #23 from Ketchuso/k-python-drink
Added and Formatted README
2 parents e18f4da + 0832ead commit 29f58ed

File tree

1 file changed

+40
-23
lines changed

1 file changed

+40
-23
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,46 @@
1-
🍹🍺 The Thirsty Python Bar πŸ₯ƒπŸΈ
2-
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.
3-
4-
πŸŽ‰ Features πŸŽ‰
5-
πŸ™‹ Customer Creation: Create a customer profile and verify if they are old enough to enter the bar.
6-
πŸ₯³ Birthday Fun: Celebrate your birthday and automatically update your age when you do.
7-
🍹 Drink Management: Add, remove, and select drinks from the menu.
8-
πŸ’³ Tabs: Track the drinks a customer has ordered. Open a new tab, view previous orders, and switch between tabs.
9-
πŸ’΅ Tab Closure: Once the customer has closed their tab, all their orders are removed from the system, and the customer is logged out.
10-
πŸ’Ύ SQL Backend: The system uses an SQL database to store, update, and retrieve customer and drink data.
11-
12-
πŸ’» Technologies Used πŸ’»
13-
* Python: The core programming language for logic and CLI interaction.
14-
* CLI: Command Line Interface for interaction with the system.
15-
* SQL: Database management to store customer profiles, drink menus, and order data.
16-
17-
πŸ’Ύ Starting the Program πŸ’Ύ
1+
# 🍹🍺 The Thirsty Python Bar πŸ₯ƒπŸΈ
2+
3+
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.
4+
5+
---
6+
7+
## πŸŽ‰ Features πŸŽ‰
8+
9+
- πŸ™‹ **Customer Creation**: Create a customer profile and verify if they are old enough to enter the bar.
10+
- πŸ₯³ **Birthday Fun**: Celebrate your birthday and automatically update your age when you do.
11+
- 🍹 **Drink Management**: Add, remove, and select drinks from the menu.
12+
- πŸ’³ **Tabs**: Track the drinks a customer has ordered. Open a new tab, view previous orders, and switch between tabs.
13+
- πŸ’΅ **Tab Closure**: Once the customer has closed their tab, all their orders are removed from the system, and the customer is logged out.
14+
- πŸ’Ύ **SQL Backend**: The system uses an SQL database to store, update, and retrieve customer and drink data.
15+
16+
---
17+
18+
## πŸ’» Technologies Used πŸ’»
19+
20+
- **Python**: The core programming language for logic and CLI interaction.
21+
- **CLI**: Command Line Interface for interaction with the system.
22+
- **SQL**: Database management to store customer profiles, drink menus, and order data.
23+
24+
---
25+
26+
## πŸ’Ύ Starting the Program πŸ’Ύ
27+
1828
To get started, first clone the repository:
19-
git clone [email protected]:Ketchuso/python-phase3-project.git
20-
cd python-phase3-project
29+
30+
- git clone [email protected]:Ketchuso/python-phase3-project.git
31+
- cd python-phase3-project
32+
2133
Make sure you have Python installed (version 3.7 or above).
34+
2235
To start the application, open your terminal and run the following command:
23-
python lib/cli.py
2436

25-
πŸ™ Acknowledgments πŸ™
26-
A huge thank you to the talented developers who contributed to this project Jay, Victoria and Kerissa
37+
- python lib/cli.py
38+
39+
## πŸ™ Acknowledgments πŸ™
40+
41+
A huge thank you to the talented developers who contributed to this project:
42+
Jay, Victoria, and Kerissa
43+
44+
## πŸ“œ License πŸ“œ
2745

28-
πŸ“œ License πŸ“œ
2946
This project is licensed under the MIT License.

0 commit comments

Comments
Β (0)