Skip to content
MushmatPublic

About

Wiggles is a mobile app designed to connect pet lovers with their perfect companions. Discover, save, and adopt pets with ease, access essential pet care tips, and enjoy a seamless adoption experience. Find your new best friend today!

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

301 Commits

Folders and files

Repository files navigation

Logo

🐾 Wiggles - Your Ultimate Pet Adoption Companion 🐾

(Prototype Version 0.9.0-alpha)

Welcome to Wiggles! This comprehensive mobile application facilitates the adoption process for cats and dogs. Wiggles connects potential pet owners with pets needing a home, providing detailed profiles and personalized recommendations to ensure the perfect match. Our mission is to streamline the adoption process and support pet owners with valuable resources.

🎯 Objectives

  • Promote Pet Adoption: Increase the adoption rates by providing a user-friendly platform where users can browse and adopt pets.
  • Personalized Recommendations: Match users with pets that fit their lifestyle and preferences using a quiz-based recommendation system.
  • Support Pet Owners: Offer resources such as pet care tips, nearby vet locations ,and community support to ensure a smooth transition for new pet owners.
  • Comprehensive Pet Profile: Provide detailed information about each pet to help users make informed decisions.

🔍 Features

  • Exclusive Pet Profiles: Every pet gets a unique profile with detailed information.

  • Hassle-Free Adoption: Streamlined process for adopting pets.

  • Personalized Recommendations: Quiz-based system to match pets with owners.

  • Data Persistence: Local storage with Room Database.

  • User Authentication: Secure login and signup with Firebase.

  • Adoption Request Tracking: Monitor the progress of your adoption applications.

  • Pet Filtering and Bookmarking: Easily find and save your favorite pets.

  • Pet Care Tips: Essential tips to help you care for your new pet.

  • Nearby Pets Locator: Find pets available for adoption near you.

  • Community Connection: Connect with other pet owners.

  • Modern UI & Easy-to-Use: A visually appealing and intuitive interface.

  • Shelter Information: Details about local shelters.

  • Informational Screens: About Us, FAQs, and more.

🛠️ Implementation Details

  • User Authentication: Secure user login and signup using Firebase Authentication.

  • Data Persistence: Local storage using Room Database to keep track of user profiles, bookmarked pets, and adoption applications.

  • Pet Profiles: Detailed pet profiles are displayed using data fetched from a predefined dataset.

  • Personalized Quiz: A quiz-based system that collects user preferences and suggests pets accordingly.

  • Adoption Application: Users can submit adoption applications and track their progress within the app.

  • Modern UI Design: A visually appealing interface designed using Jetpack Compose, with gradient buttons and customized themes.

  • Navigation: Seamless navigation throughout the app using Jetpack Navigation Component.

📚💻 Code Documentation

Code Documentation

📥 Installation

To run the Wiggles App, follow these steps:

Follow the link

Go on this link to download the apk

OR Run using Android Studio:

Prerequisites

Before you can run the Wiggles App, ensure you have the following installed on your system:

Steps to Install and run

  1. Clone the Repository
  • Go to the Github repository and click on the 'Code' button.

  • Copy the HTTPS web URL:

https://github.com/Mushmat/Wiggles.git
  1. Open the Project in Android Studio
  • Open Android Studio (latest version)
- File > New > Open from Version Control
  • Paste the copied URL and clone the repository
  1. Wait for Gradle Build
  • The files will be cloned and the project will open shortly once the Gradle build is finished.
  1. Run the App
  • Once the Gradle build is complete, you can run the app using the play button present on the top bar.

  • Select an emulator or connect an Android device to run the app.

Additional Setup (Optional)

If you encounter any issues or need further customization, refer to the following resources:

🛠️ Tech Stack

The Wiggles App is build using the following technologies:

Frontend: Kotlin, Jetpack Compose, Android Studio

Backend: Firebase Authentication, Firebase Firestore

Libraries and Tools: Coil, Room Database, Navigation Component, Gradle

Additional Services: Github

🎨 Color Reference

Color Hex
Dark Blue #1a1a73 #1A1A73
Orange #ff7043 #FF7043
Black #000000 #000000
Purple #8e44ad #8E44AD
Red #FF0000 #FF0000
Green #388e3c #388E3C
Light Blue #3498db #3498DB

🚧 Challenges Faced

  • Responsiveness: Ensuring the app remains responsive while processing complex AI algorithms.
    Solution: Implemented asynchronous processing and optimized algorithms.
  • Scalability: Designing for a growing user base and data volume.
    Solution: Utilized cloud services for scalable storage and processing.
  • Data Synchronization: Ensuring data consistency across devices.
    Solution: Integrated Firebase for secure and consistent data storage.
  • UI Design: Creating an intuitive interface.
    Solution: Conducted user research and iterative improvements.

🔮 Future Scope

  • Realtime Data: Collaborate with pet shelters for real-time pet data.
  • Pet Services: Implement services for pet care such as vaccination schedules.
  • In-App Messaging: Allow direct communication with shelters and other pet owners.
  • Advanced Filtering: Enhance filtering options with more criteria.
  • AI-Powered Recommendations: Improve accuracy of recommendations with machine learning.
  • Stronger Authentication: Add SMS verification and email notifications.
  • Volunteer Opportunities: Platform for finding volunteer opportunities.
  • Social Media Integration: Share adoption stories and profiles on social media.
  • Donate: Allow users to donate to shelters.

❓ FAQs

  1. What is Wiggles?
    Wiggles is an Android app designed to help users find and adopt pets.

  2. System Requirements:

    • Android Studio (latest version)
    • JDK 8 or higher
    • Android Emulator or real device
    • Internet connection
  3. How to Contribute?

    • Fork the repository
    • Create a new branch
    • Commit changes with clear messages
    • Push to your forked repo
    • Create a pull request
  4. Reporting Bugs/Features:
    Create an issue on GitHub with detailed information.

  5. Costs:
    Wiggles is free to use.

  6. iOS Version:
    Currently available for Android only.

🙌 Acknowledgements

  • Pet Finder: Inspiration and resources.
  • Android Studio Developers: Comprehensive development tools.
  • Firebase: Robust backend services.
  • Coil: Efficient image loading.
  • GitHub: For storage and improvisations.
  • OpenAI: Language models for generating content and code suggestions.
  • Contributors: Valuable feedback and support during development.

Thank You

About

Wiggles is a mobile app designed to connect pet lovers with their perfect companions. Discover, save, and adopt pets with ease, access essential pet care tips, and enjoy a seamless adoption experience. Find your new best friend today!

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages