/ShopSmart

A Shopping list app developed using Kotlin(Jetpack Compose). It allows users to create, edit, and manage their shopping lists same as to-do lists for daily use.

Primary LanguageKotlinMIT LicenseMIT

ShopSmart: Your Smart Shopping Companion

Effortless shopping, simplified. 🛒

ShopSmart is a user-friendly shopping list app built with Kotlin and Jetpack Compose. From organizing items by category to adding them through voice commands, ShopSmart helps you streamline your grocery shopping experience—whether you're online or offline.

🔗 Table of Contents

  1. Features
  2. Preview
  3. Tech Stack
  4. Setup Guide
  5. Contributing
  6. License
  7. Support

✨ Features

✔️ Developed Features

  • 📝 List Management: Create, update, and manage multiple shopping lists effortlessly.
  • 🌑 Dark Mode: Switch to dark mode for a comfortable low-light experience.

🚧 In Progress / Upcoming Features

  • 📦 Category-Based Sorting: Automatically organize items by category for a more streamlined shopping experience.
  • 🎤 Voice Input: Add items hands-free using voice commands.
  • 📶 Full Offline Support: Access and manage all your lists without an internet connection.
  • 💰 Budget Tracking: Get price estimates and manage your budget in real time.
  • 🔔 Reminders: Never miss a shopping trip with timely reminders.

📱 Preview

Home Screen List Creation Dark Mode
Splash Screen) List Creation Dark Mode

🛠️ Tech Stack

  • Kotlin: The core language for Android development.
  • Jetpack Compose: Android’s modern UI toolkit.
  • MVVM: Clean, maintainable architecture using the Model-View-ViewModel pattern.
  • Room Database: Local database for storing shopping lists.
  • Android SDK: Provides tools and libraries for Android app development.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Contributing Guidelines

We believe in the power of collaboration. If you have ideas to improve ShopSmart, feel free to contribute! Check out our Contribution Guidelines to get started.

🚀 Setup Guide

To get started with ShopSmart, follow these steps:

  1. Fork It: Fork the project to create your own copy.

  2. Clone the repository:

    $ git clone https://github.com/<your-account-username>/<your-forked-project>.git

  3. Open in Android Studio:
    Open the cloned project in Android Studio.

  4. Build & Run:
    Connect your Android device or launch an emulator, then hit the Run button in Android Studio to build and deploy the app.

🤝Contributing

We’re excited for you to contribute to ShopSmart! Here’s how:

  1. 🌿 Branch Out: Create a new branch with a meaningful name (MANDATORY).

    $ git checkout -b <your_branch_name>

  2. ✍️ Make Changes: Modify existing files, add new ones, or remove unnecessary ones.

  3. 📁 Track Changes: Add the changed files to the staging area.

    $ git add .

  4. 🚚 Commit: Commit your changes with a descriptive message.

    $ git commit -m "<commit message>"

  5. 🚀 Push Changes: Push your committed changes to your forked repository on GitHub.

    $ git push -u origin <your_branch_name>

  6. 🌐 Create Pull Request: On GitHub, navigate to your forked repository and initiate a pull request by clicking "Compare & pull request".

    For detailed contributing guidelines, check out CONTRIBUTING.md.

📜License

This project is licensed under the MIT License. See the LICENSE file for details.

💪 Thanks to all Contributors

Thanks to all contributors for helping this project grow! 🍻

🙏 Support

Found a bug or have a feature request? Please open an issue. If you like the project, don’t forget to give it a ⭐!

Crafted with ❤️ by Yuvraj Singh