diff --git a/README.md b/README.md new file mode 100644 index 0000000..41876bb --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +Preview Screenshot + +

Combo Menu - CLI/GUI

+ +### 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** \ No newline at end of file diff --git a/images/preview_screenshot.png b/images/preview_screenshot.png new file mode 100644 index 0000000..7e270d3 Binary files /dev/null and b/images/preview_screenshot.png differ diff --git a/tech_stack.png b/images/tech_stack.png similarity index 100% rename from tech_stack.png rename to images/tech_stack.png diff --git a/server.py b/server.py index 00db834..2b1b214 100644 --- a/server.py +++ b/server.py @@ -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()