Skip to content

Latest commit

 

History

History
185 lines (109 loc) · 8.93 KB

README.md

File metadata and controls

185 lines (109 loc) · 8.93 KB
InstaFoodies Logo

🍴 Frontend Delights: A Culinary Adventure with InstaFoodies 📸

Welcome to the enchanting realm of InstaFoodies' frontend, where the art of cooking converges with the magic of social connection!


Table of Contents


📑 Introduction

Discover Flavorful Frontend Adventures

Step into a world where recipes become stories and culinary creativity knows no bounds. InstaFoodies' frontend is your portal to a vibrant community of food enthusiasts, where each screen and interaction is designed to elevate your culinary journey. 🍳🎨👨‍🍳👩‍🍳

Savory Features at Your Fingertips

Craft, share, and savor the magic of cooking with ease. Unleash your inner chef with the "Post Creation and Editing" module, elegantly blending images, descriptions, and instructions. Forge connections with like-minded food lovers using the intuitive "Chat Messaging" component. 💬📝

A Fusion of Design and Passion

Every pixel of InstaFoodies' frontend is a labor of love, catering to your craving for both aesthetic pleasure and seamless functionality. Whether you're discovering global flavors or sharing your culinary creations, our UI promises an experience as delightful as your favorite dish. 🧡🎨

Embark on Your Culinary Odyssey

Get ready to immerse yourself in a world where recipes come to life and friendships are forged over shared flavors. InstaFoodies' frontend is your gateway to a culinary adventure that marries the art of cooking with the joy of connection.

Fire up your creativity, ignite your taste buds, and embark on a journey where food, fun, and friendship meet in perfect harmony.

Bon appétit and bon voyage! 🍽️🌍


📋 System Overview

InstaFoodies UI is the captivating facade of our dynamic recipe-sharing application, an innovative social media platform designed for users to effortlessly share and explore new culinary creations. Our users can craft and edit recipe posts, follow other culinary aficionados, embark on a culinary journey through a diverse recipe repertoire, and stay informed through real-time notifications. The UI boasts a sleek and intuitive design to ensure an immersive and engaging experience. 📸👨‍🍳🌟


System Architecture

📱 Architectural Design

Our UI is architected using the Model-View-ViewModel (MVVM) design pattern, a cornerstone for maintainable and scalable app development. The MVVM pattern empowers us with:

  • Model: Expertly handles data logic and facilitates communication with the backend.
  • View: Artfully crafts the Android UI, utilizing layouts and user interface components.
  • ViewModel: Seamlessly orchestrates data preparation for the UI and encapsulates UI-centric logic. 🏛️🛠️

Decomposed Modules

Our UI is meticulously divided into a symphony of modules, each finely tuned to orchestrate a specific realm of functionality:

User Authentication and Registration

  • Component: Login 🔐
  • Responsibilities: Expertly handles user registration and authentication, prioritizing security and seamless user experience.

Post Creation and Editing

  • Component: Post 📝
  • Responsibilities: Empowers users to sculpt and refine their culinary masterpieces, effortlessly intertwining captivating images with descriptive narratives.

Feed Display and Navigation

  • Component: Feed 🍔
  • Responsibilities: Transforms your feed into a culinary odyssey, elegantly showcasing posts, likes, comments, and shares.

User Profile and Settings

  • Component: Profile 👤
  • Responsibilities: Elevates personalization by furnishing users with a canvas to curate their profiles, tantalizingly painting their culinary identity.

Search Functionality

  • Component: Search 🔍
  • Responsibilities: Unleashes the power of exploration, offering users a portal to discover fellow food enthusiasts and delectable recipes.

Notifications

  • Component: Notifications 🔔
  • Responsibilities: Elevates interaction with real-time notifications, seamlessly connecting users to their culinary community.

Chat Messaging

  • Component: Chat 💬
  • Responsibilities: Facilitates engaging and real-time conversations, sating the appetite for connection.

Content Recognition and Reporting

  • Component: ContentRecognition 🕵️
  • Responsibilities: Safeguards the platform's integrity by leveraging AI to identify and address potential content violations.

Recipe Web Scraping and Integration

  • Component: Scraping 📚
  • Responsibilities: Bridges the culinary divide by ingeniously integrating external recipes, inspiring creativity without leaving the app.
  • Note: Our pursuit is one of enlightenment, driven solely by the thirst for knowledge rather than the pursuit of widespread data consumption. In this noble endeavor, we have meticulously gathered a subset of information, deliberately chosen for educational insight. Our commitment to the integrity of this endeavor is steadfast, as we safeguard the origins of our acquired data, a testament to our respect for the sources that contribute to the enrichment of understanding.

Business account and payment

  • Component: Business 💸

  • Responsibilities: Empowers professional chefs and cooking enthusiasts to showcase their exclusive content. Users can access this premium content through a subscription-based payment model, offering a convenient and value-added experience.


Human Interface Design

Our UI is a canvas of user-centric design, harmoniously merging aesthetics and functionality to craft an unparalleled experience.

Key screens include:

Table of Contents

Login Register Feed
login register feed
Post Comments Scraping
post comments scraping
Networking Chat Requests Chat
chats requests chat
Notifications Search Payment
notifications search payment

For a comprehensive tour of each module's symphony, meticulously composed to serenade your culinary senses,

please navigate to the Decomposed Modules section above. 🎨📱


📚 References

This project incorporates code and inspiration from external sources. We'd like to give credit to the following creators and repositories:

We express our gratitude to the original authors for their invaluable contributions 👏.

📜 License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0). This means that you are free to share, adapt, and build upon the material, as long as you provide appropriate attribution, do not use the material for commercial purposes, and do not impose additional legal restrictions.

Please note that this license is designed to prevent commercial usage of the code. If you have any questions about how you can use or adapt this code within the terms of the license, feel free to contact us via email smartefoodies@gmail.com 📮.

📬 Contact

If you have any questions, suggestions, or feedback, please don't hesitate to contact us:

smarterfoodies@gmail.com 📮.