https://github.com/prangonghose/calorie-counter
The aim of this project is to create a Calorie Counter as the final project for the masters course of Python.
https://github.com/prangonghose/calorie-counter
error-handling oops-in-python python3
Last synced: 11 months ago
JSON representation
The aim of this project is to create a Calorie Counter as the final project for the masters course of Python.
- Host: GitHub
- URL: https://github.com/prangonghose/calorie-counter
- Owner: PrangonGhose
- Created: 2023-10-09T21:09:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-16T22:37:39.000Z (over 2 years ago)
- Last Synced: 2025-03-29T01:28:18.735Z (about 1 year ago)
- Topics: error-handling, oops-in-python, python3
- Language: Python
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Calorie Counter
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
# 📖 Project Name
## Calorie Counter
### About this project
The aim of this project is to create a Calorie Counter as the final project for the masters course of Python.
- `Python`
### Key Features
- The program can display a list of items as menu by reading data from a JSON file. As an added advantage, only updating the JSON file can update the menu and entire order taking process in the next run.
- The user can choose what to order by simply typing the names of the food items available in the order. Invalid or spelling mistakes in an order will be displayed to the user for correction.
- A valid order will create an `Order` object and will go through a process of calorie and price counting after which total calorie and total price will be displayed to the user.
- Order will be refused if the total calorie is more than 2000.
- All orders are stored in a `JSON` file and can be visualized using `matplotlib` by running `visualize.py` file. The `all_orders.json` file is initially populated for visualization purpose.
- Running only the `main.py` drives the whole program to return the desired output.
## 💻 Getting Started
To clone the repository in local environment try following steps.
### Prerequisites
- [x] A web browser like Google Chrome.
- [x] A code editor like Visual Studio Code with `Git` and `Python3`.
- [x] `Matplotlib`
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for Node.js and npm for package installation.
```
$ python --version
```
### Setup
Clone the repository using [this link](https://github.com/PrangonGhose/Calorie-Counter.git).
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone https://github.com/PrangonGhose/Calorie-Counter.git
```
### Get into development
In the terminal, run these commands to get into development.
```
$ cd Calorie-Counter
$ python main.py
```
👤 **Prangon Ghose**
- GitHub: [@PrangonGhose](https://github.com/PrangonGhose)
- LinkedIn: [Prangon Ghose](https://www.linkedin.com/in/prangon-ghose/)
Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.
Feel free to check the [issues page](https://github.com/PrangonGhose/Calorie-Counter/issues).
Give a ⭐️ if you like this project!
Authors would like to thank:
- Instructor [Sam Onaisi](https://www.linkedin.com/in/sam-onaisi-1a8585a2/)
- [Learning Planet Institute](https://www.learningplanetinstitute.org/en/)
- [Université Paris Cité](https://u-paris.fr/en/)