©2024 Bogdan Stăiculescu, Hayri Ozdemir, Kevin Eboda, Patrick Skipworth and Sam Draper
Fridge Wizard helps you to save money and waste less food by keeping track of the expiry dates of ingredients in your fridge, alerting you when they're past their best and suggesting recipes for your next meals based on what's going off next. Become a Fridge Wizard today at: URL !
- Create a user profile and keep track of items in your fridge and their expiry dates.
- Generate recipes based on the items in your fridge.
- Prioritise close-to-expiry items in recipes.
- Switch between multiple fridges to keep track of items across different locations or businesses.
- Automatically assign standard expiry dates for common items.
- Receive alerts when items are close to expiry.
- Access Fridge Wizard from a dedicated mobile app.
Fridge Wizard was extended from Fridge Hero by Patrick Skipworth. Fridge Hero was developed by Bogdan Stăiculescu, Hayri Ozdemir, Kevin Eboda, Patrick Skipworth and Sam Draper.
Fridge Wizard uses a React framework with Javascript, a Django backend with Python and a Mongo database. Fridge Wizard's frontend uses Axios to make requests to the backend, and the backend uses Pymongo to make HTTP requests to the MongoDB.
To install Fridge Wizard locally:
Go to GitHub and clone the whole Git repo.
In a terminal, cd to fridge-wizard/frontend/. In the CLI, execute npm install to install dependencies.
In another terminal, cd to fridge-wizard/backend/. In the CLI, execute pipenv install to install dependencies.
To run Fridge Wizard locally:
You will need an active MongoDB connection to use most of Fridge Wizard's features. MongoDB connections can be managed conveniently with the MongoDB Compass app. (You can download it from here)
In another terminal, cd to fridge-wizard/backend/. In the CLI, execute pipenv install to update dependencies, then pipenv shell to start the virtual environment, then python manage.py runserver from within the virtual environment to run the backend server. By default, it runs on port 8000.
In a terminal, cd to fridge-wizard/frontend/. In the CLI, execute npm install to update dependencies, then npm run start to run the frontend server. By default, it runs on port 3000. Once the frontend starts succesfully it should then automatically open a browser window for you with Fridge Wizard.
Alternatively, if this doesn't happen automatically; while the servers are running, open your browser of choice and navigate to http://localhost:3000/ to begin using Fridge Wizard.
A suite of backend and frontend tests are included with Fridge Wizard. All backend tests files are in fridge-wizard/backend/tests/ and use Python's unittest library to perform tests. All frontend tests files are in fridge-wizard/frontend/tests/ and use JavaScript's jest library to perform tests.
To run backend tests, cd to fridge-wizard/backend. In the CLI, execute python -m unittest discover -v -s tests -p '*_test.py'.
To run frontend tests, cd to fridge-wizard/frontend. In the CLI, execute npm test.
The outcome of each test will be printed in the terminal console.
To run cypress end to end tests, cd to fridge-wizard/frontend. In the CLI, execute npm cy:open.
TK