https://github.com/danzigerrr/fridge-manager
App designed to reduce food waste by managing prodcuts in your fridge
https://github.com/danzigerrr/fridge-manager
Last synced: over 1 year ago
JSON representation
App designed to reduce food waste by managing prodcuts in your fridge
- Host: GitHub
- URL: https://github.com/danzigerrr/fridge-manager
- Owner: Danzigerrr
- License: apache-2.0
- Created: 2023-06-21T08:11:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-05T14:43:10.000Z (almost 3 years ago)
- Last Synced: 2025-01-22T18:35:14.106Z (over 1 year ago)
- Language: Python
- Size: 252 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fridge Manager - web application using Django framework
## Manage food in your fridge and get inspired by recipes based on your current products - fight food waste today!
### Author: **Krzysztof Nazar**
## Table of contents
* [Live demo](#Live-demo)
* [The goal of the project](#the-goal-of-the-project)
* [Main functionalities of the application](#main-functionalities-of-the-application)
* [Watch the user tutorial](#watch-the-user-tutorial)
* [Run project locally](#run-project-locally)
+ [Installation of libraries](#installation-of-libraries)
+ [Running the project](#running-the-project)
* [Why did I create this project?](#why-did-i-create-this-project-)
* [What I've learnt during this project?](#what-i-ve-learnt-during-this-project-)
* [Used libraries](#used-libraries)
* [Possible future improvements](#possible-future-improvements)
* [Contributing](#contributing)
* [License](#license)
## Live demo
Use [**this link**](https://fridgemanagerbykn.pythonanywhere.com/) to check the demo of this application hosted by [Pythonanywhere.com](https://pythonanywhere.com).
## The goal of the project
**The goal of this project is to deploy a Django web application allowing the users to manage their fridges and reduce the food waste.**
The key functionality of the app is to search for recipes using the products stored currently in the fridge.
## Main functionalities of the application
The application provides an interface and tools designed for managing products stored in a fridge.
The key functionalities in the app include:
- **Register as a new user** - Register to the system.
- **Add your fridge** - Create your fridge and define its details
- **Share your fridge with another users** - Use an invitation link, send it to another user, and manage one fridge together
- **Add products to your fridge** - Add new products by defining their name, expiration date, amount, etc.
- **Search for recipes** - Check out the meal which can be made using the products in your fridge
- **User dashboard** - See statistics of your account in one place
[//]: # (## Watch the user tutorial)
[//]: # (Here is the tutorial available on YouTube:)
[//]: # ()
[//]: # ([](https://youtu.be/VIDEO_ID))
## Run project locally
### Installation of libraries
1. Install virtualenv:
```bash
pip install virtualenv
```
2. Create a virtual environment:
```bash
virtualenv
```
3. Activate the environment:
```bash
source /bin/activate
```
4. Install the requirements in the current environment:
```bash
pip install -r requirements.txt
```
5. This step is optional - if you want to deactivate your current environment use hte following command:
```bash
deactivate
```
### Set up Spoonacular API
1. Register at Spoonacular [**here**](https://spoonacular.com/food-api/console#Dashboard)
```bash
deactivate
```
2. Copy your private api key from the user [dashboard](https://spoonacular.com/food-api/console#Profile).
Remember to keep your api key private and do not share it publicly!
3. Create *.env* file with api key in the directory with *manage.py* file (FridgeManager/fridgemanager).
Use the template given below and paste your private api key.
```python
SPOONACULAR_API_KEY=your_api_key
```
### Running the project
With active virtual environment, run the following commands to run the Django project.
1. Go to the project directory:
```bash
cd fridgemanager
```
2. Run server using manage.py file:
```bash
python manage.py runserver
```
## Why did I create this project?
By creating this app I would like to have an impact on the global food waste problem.
According to [Greenly Institute](https://greenly.earth/en-us/blog/ecology-news/global-food-waste-in-2022):
"Over a third of all food produced (~2.5 billion tons) is lost or wasted each year.
One third of this occurs in the food production stage.
Boston Consulting Group (BCG) estimates this wasted food is worth $230 billion.
👉 Researchers estimate the lost food calories from food waste amount to roughly 24% of the total available food calories."
Users of my app can **#ActLocallyAndThinkGlobally** by reducing their own food waste.
## Database diagram
The database diagram shows the relationships between the models. It was generated using DataGrip from Jetbrains.
## What I've learnt during this project?
During this project I learnt how to:
- setup user authorisation in Django ([docs](https://docs.djangoproject.com/en/4.2/topics/auth/))
- use Bootstrap for styling ([docs](https://getbootstrap.com/docs/4.0/content/images/))
- create custom error pages ([tutorial](https://dev.to/riyanagueco/creating-a-custom-error-page-on-django-3nnd))
- manage relationships between Django models ([docs](https://docs.djangoproject.com/en/4.2/topics/db/models/))
- improved my skills in creating Django forms ([docs](https://docs.djangoproject.com/en/4.2/topics/forms/))
- use spoonacular API ([docs](https://spoonacular.com/food-api/docs))
- create a better README.md
- write Unit tests in Django ([docs](https://docs.djangoproject.com/en/4.2/topics/testing/))
## Used libraries
- Django
- requests
- secrets
## Possible future improvements
- **Add an option to define the priority of products used as ingredients** - the user can define what products he/she wants to use today
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)