An application for all your grocery and cooking needs. Find out more in the sections below.
Table of Contents
The purpose of this application is to ease the strenuous process of keeping on top of all your weekly grocery, cooking, and shopping related chores. It includes various functionalities to fulfil this purpose.
A secondary purpose of this application is to upload and share meals with the community of people using Ingredilist. Uploading your own created meals and sharing it with other like-minded individuals gives the user an opportunity to make interesting meals of their own based on the ideas of others.
Some of the functionalities within the application are listed below (to see the full functionality in action, visit the user guide).
- Create a meal locally
- Update a meal locally
- Delete a meal locally
- Upload/share a meal
- Delete a shared meal
- View shared meals by other users with their diet types
- Create a shopping list
- Delete items on the shopping list
- Delete items on the shopping list
- Create cooking instructions with the time taken to cook per each instruction
- Set a cooking timer countdown that notifies you when it reaches 0
- Set a shopping alarm time and date for when you would like to go shopping
- Add and save supermarket phone numbers which you can call directly from the app
- User guide is available on the Settings screen
- Ability to adapt to different screen sizes and orientations
This section lists all major frameworks, programming languages, markup languages and database structures used throughout the project.
This section lists all plugins, packages, and libraries used throughout the project.
- AlarmManager
- Intent
- Content Provider
- SQLite
- SharedPreferences
- BroadcastReceiver
- ShareActionProvider
- NotificationCompat
- Google Services Plugin
- ConstraintLayout 2.0.4
- RecyclerView 1.2.0
- Firebase Authentication
- Firebase Database
- Firebase Firestore
- Firebase UI 7.1.1
- JUnit Testing 4.13.2
- Espresso Testing 3.3.0
To set up this project, get a local copy up and running by either cloning this repository to Android Studio, or downloading the ZIP file of the repository and opening it in Android Studio.
You will need to install the following software in order to run this project.
- Android Studio
- Git (if cloning the repository)
- Download and install Android Studio. The download link and installation guide can be found on the following link: https://developer.android.com/studio/install
- Press "Clone Repository" in Android Studio. Copy the following repository URL:
https://github.com/SaoodCS/Ingredilist
- Update any gradle and build files if requested by Android Studio
- Install an AVD emulator to run the app on in Android Studio
5. To run the app, either:
a. Press the play button in the top toolbar in Android Studio to run the app on the emulator.
OR:
b. Run the AVD emulator -> Once loaded, drag and drop "ingredilist apk.apk" from the projects folder to the emulator screen -> find the app on the android emulator and press it.
This application has a very comprehensive user guide highlighting how to use the app alongside all the various functionalities the
application has to offer. This user guide also includes screenshots of every activity and fragment screen too.
- The user guide is available as an integrated web app within the application itself on the settings screen, or can be accessed by clicking the following link: User Guide Documentation
- If you would like to use the application without registering, just use the following details to do so:
Username: eee
Password: eee
As of now, this project isn't open to contributions. The only contributer is myself, though this may change in the future.
Distributed under the MIT License.
Saood - saood-aslam@outlook.com
Project Link: https://github.com/SaoodCS/Android-App-Ingredilist