Welcome to the Meal Monkey repository! This repository contains the source code for a food application built using Flutter. The app incorporates geolocation features, Firebase authentication, and Firestore database functionality. Additionally, there is an admin website included to manage the app's database and modify crucial app details.
The Meal Monkey offers a range of features to enhance the user experience and streamline the process of ordering food. Some of the key features include:
- Geolocation: The app utilizes geolocation services to detect the user's location and provide nearby restaurants and food options.
- Firebase Authentication: Users can create accounts, log in, and authenticate themselves securely using Firebase authentication.
- Firestore Database: The Firestore database is used to store and retrieve user information, orders, menu items, and other app-related data.
- Ordering System: Users can browse through menus, select items, customize their orders, and place orders within the app.
- Payment Integration: The app integrates with popular payment gateways, allowing users to securely make payments for their orders.
- Real-time Order Tracking: Users can track the status of their orders in real-time, ensuring they stay informed about the progress. (Not implemented yet)
- Notifications: Users receive notifications regarding order updates, promotions, and other relevant information.
- User Reviews and Ratings: Users can leave reviews and ratings for restaurants and food items, helping others make informed decisions.
- Favorites and History: Users can save their favorite restaurants, view order history, and reorder items easily.
- Admin Website: An admin website is included to manage the app's database, add/edit/delete restaurants and menu items, and perform other administrative tasks.
To get started with the Food App, follow the steps below:
-
Clone the Repository: Clone this repository to your local machine using Git.
git clone https://github.com/your-username/meal_monkey.git
-
Configure Firebase: Create a Firebase project and set up the necessary authentication and Firestore services. Obtain the Firebase configuration details and update them in the app's codebase.
-
Set Up the Admin Website: Deploy the admin website to a hosting platform of your choice. Make sure to configure the necessary environment variables, such as Firebase API keys, in the website's codebase.
-
Install Dependencies: Use Flutter's package manager,
pub, to install the project dependencies.flutter pub get
-
Run the App: Connect your mobile device or start an emulator and run the app.
flutter run
We welcome contributions to the Food App repository. If you would like to contribute, please follow these guidelines:
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes, ensuring that the codebase remains clean and well-documented.
- Write appropriate unit tests to validate your changes.
- Commit your changes and push them to your fork.
- Submit a pull request, explaining the changes you made and why they are valuable.
The Food App is released under the MIT License. You are free to use, modify, and distribute the codebase according to the terms and conditions of the license.
If you have any questions or suggestions regarding Meal Monkey, feel free to contact us at [email protected]. We appreciate your feedback and involvement in making this app better.
Happy coding and enjoy your food with the Meal Monkey!