Skip to content

README.md

Latest commit

 

History

History
349 lines (251 loc) · 15.7 KB

README.md

File metadata and controls

349 lines (251 loc) · 15.7 KB
Raw

🛍️ ShopSmart – Your Smart Shopping Companion

MIT License Kotlin Jetpack Compose

📖 Table of Contents

🔍 Overview

A modern Android shopping companion app that revolutionizes your local shopping experience with smart features and intuitive design.

Thanks Banner Typing SVG

📊 Project Insights

🌟 Stars 🍴 Forks 🐛 Issues 🔔 Open PRs 🔕 Closed PRs 🛠️ Languages 👥 Contributors
Stars Forks Issues Open PRs Closed PRs Languages Count Contributors Count

Open Source Love svg1 PRs Welcome Built with Love Visitors GitHub Contributors GitHub Last Commit GitHub Repo Size GitHub Total Lines Github

📱 Key Features

🔍 Smart Shopping

  • Voice & text-based product search with AI-powered suggestions
  • Real-time inventory tracking and price comparisons
  • Barcode scanning for instant product information
  • Location-based store recommendations

📋 List Management

  • Create and manage multiple shopping lists
  • Smart categorization and sorting
  • Price tracking and budget estimation
  • Share lists with family members
  • Image attachments for specific items

🔔 Smart Notifications

  • Price drop alerts for wishlist items
  • Stock availability notifications
  • Deal recommendations based on shopping history
  • Order status updates

🛠️ Tech Stack

  • Frontend:

    • Jetpack Compose
    • Material Design 3
    • View Models
    • Kotlin Coroutines

  • Backend:

    • Room Database
    • Retrofit for API calls
    • Hilt for dependency injection
    • Firebase Analytics

  • Architecture:

    • MVVM (Model-View-ViewModel)
    • Clean Architecture principles
    • Repository pattern

🚀 Getting Started

Prerequisites

  • Android Studio Arctic Fox or later
  • JDK 11 or higher
  • Android SDK 21+
  • Kotlin 1.8.0+

Installation

  1. Clone the repository
git clone https://github.com/yourusername/ShopSmart.git

  1. Open project in Android Studio

  2. Add your API keys in local.properties :

PIXABAY_API_KEY=your_key_here
MAPS_API_KEY=your_key_here
  1. Build and run the project

📸 Screenshots

Home Screen Shopping List Product Search
(Coming Soon) (Coming Soon) (Coming Soon)

🤝 Contribute

We welcome contributions from developers of all skill levels — whether it’s fixing bugs, adding features, improving documentation, or enhancing UI/UX. 💚

Ways to Contribute

  • 🐛 Bug fixes – Identify and resolve issues
  • ✨ New features – Suggest and implement functionality
  • 📚 Documentation – Improve guides and instructions
  • 🎨 UI/UX improvements – Make the platform more user-friendly
  • 🔧 Performance – Optimize speed and efficiency
  • 📱 Mobile responsiveness – Enhance the mobile experience
  • 🔒 Security – Strengthen data protection

Getting Started

  1. Fork the repository
  2. Create a feature branch 
    git checkout -b feature/YourFeature

Issue Creation ✴

Report bugs and issues or propose improvements through our GitHub repository's "Issues" tab.

Contribution Guidelines 📑

  • Firstly Star(⭐) the Repository
  • Fork the Repository and create a new branch for any updates/changes/issue you are working on.
  • Start Coding and do changes.
  • Commit your changes
  • Create a Pull Request which will be reviewed and suggestions would be added to improve it.
  • Add Screenshots and updated website links to help us understand what changes is all about.

Contributing is fun🧡

We welcome all contributions and suggestions! Whether it's a new feature, design improvement, or a bug fix - your voice matters 💜

Your insights are invaluable to us. Reach out to us team for any inquiries, feedback, or concerns.

🙏 Acknowledgments

  • Thanks to all contributors of this project
  • Special shoutout to GirlScript Summer of Code (GSSoC’25) for the amazing community and support!
  • Built with dedication, collaboration, and lots of chai

📞 Contact

Feel free to reach out with any questions or feedback!

📜 Code of Conduct

Please refer to the Code of Conduct for details on contributing guidelines and community standards.

🤝👤 Contribution Guidelines

We love our contributors! If you'd like to help, please check out our CONTRIBUTE.md file for guidelines.

Thank you once again to all our contributors who has contributed to ShopSmart! Your efforts are truly appreciated. 💖👏

Contributors

Contributors

See the full list of contributors and their contributions on the GitHub Contributors Graph.

Show some Red Heart by starring this awesome repository!

💡 Suggestions & Feedback

Feel free to open issues or discussions if you have any feedback, feature suggestions, or want to collaborate!

🙌 Show Your Support

If you find ShopSmart project helpful, give it a star! ⭐ to support more such educational initiatives:

  • ⭐ Starring the repository
  • 🐦 Sharing on social media
  • 💬 Telling your friends and colleagues
  • 🤝 Contributing to the project

📄 License

This project is licensed under the MIT License - see the License file for details.

⭐ Stargazers

🍴 Forkers

🧑‍💻Project Admin:

Yuvraj Singh
Yuvraj Singh

Glowing Star Give us a Star and let's make magic! Glowing Star

Mirror Ball

👨‍💻 Built with ❤️ by ShopSmart Team

❤️ Yuvraj Singh and Contributors ❤️

Open an Issue | 🌟 Star on GitHub

⬆️ Back to Top

Ready to show off your coding achievements? Get started with ShopSmart today! 🚀