Skip to content

Commit

Permalink
📌 Last Minute Changes
Browse files Browse the repository at this point in the history
- Added README.md
- Added images folder for repo images
- Changed app out of debug mode.
  • Loading branch information
KingPr0o7 committed Feb 28, 2023
1 parent f984007 commit b22f506
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<img align="center" src="images/preview_screenshot.png" alt="Preview Screenshot">

<h1 align="center">Combo Menu - CLI/GUI</h1>

### A way to order menu items, such as sandwiches to ketchup packets, and see each item detail and your full cart! Like a CLI? Choose `Release: v1.0.0`! Like a website with live interactions? Choose `Release: v2.0.0`!

# Versions
### `v1.0.0`
Release version `v1.0.0` is a strictly **CLI-based** interface. Using **Prettytables** to display cart information.

### `v2.0.0`
Release version `v.2.0.0` is a strictly **GUI-based** interface using **HTML**, **CSS**, **JS**, and **Flask**. The frontend displays information from the backend **Flask** in a more human-friendly way, in the style of a chat application.

# Installation
## CLI - `v1.0.0`
1. Install Python `v3.10.10` or newer [[python.org/downloads](https://www.python.org/downloads/)]
2. In your file explorer or IDE, navigate to the project folder using `cd path/to/directory`
3. To run the program use `python main.py`, if you have `Visual Studio Code` you can install the Python extension [[https://marketplace.visualstudio.com/items?itemName=ms-python.python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)], and simply click the run icon, whilst viewing `server.py`.

## GUI - `v2.0.0`
1. Install Python `v3.10.10` or newer [[python.org/downloads](https://www.python.org/downloads/)]
2. In your file explorer or IDE, navigate to the project folder using `cd path/to/directory`
3. Install these **requried** libraries using these commands:
- `pip install flask`
- `pip install jyserver`
4. To run the program use `python server.py`, if you have `Visual Studio Code` you can install the Python extension [[https://marketplace.visualstudio.com/items?itemName=ms-python.python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)], and simply click the run icon, whilst viewing `server.py`.
5. `Crtl` + `Left Click` on the local host link to open and view the program.

# License
### **MIT**
Binary file added images/preview_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
2 changes: 1 addition & 1 deletion server.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ def send_data():
return jsonify({'flask_output': flask_output, 'flask_output_type': flask_output_type, 'flask_cart_sizes': cart_sizes, 'flask_cart_types': cart_types, 'flask_cart_names': cart_names, 'flask_cart_prices': cart_prices, 'flask_cart_total': cart_total, 'flask_item_quantity': item_quantity, 'flask_coupon_eligibility': coupon_eligibility})

if __name__ == '__main__':
app.run(debug=True)
app.run()

0 comments on commit b22f506

Please sign in to comment.