Welcome to ShopSync Documentation¶

Share Shopping Lists

Create and share shopping lists with family and friends in real-time. Never forget an item again!

Get Started

Real-time Sync

Changes sync instantly across all devices. See updates as they happen, whether you're at home or at the store.

Learn More

Offline Mode

Access your lists even without internet. All changes sync automatically when you're back online.

Explore Offline Mode

Smart Suggestions

Get intelligent item suggestions powered by ML. Add items faster with predictive text and icons.

Discover Features

Overview¶

ShopSync is a modern, intuitive Flutter application designed to simplify shared shopping experiences. Built with Firebase and Material Design 3, ShopSync provides a seamless way to create, manage, and share shopping lists with anyone, anywhere.

Key Features¶

Real-time Synchronization - Changes sync instantly across all devices using Cloud Firestore
Offline-First Architecture - Full functionality without internet connectivity
Multi-user Collaboration - Share lists with family, friends, or roommates
Recycle Bin - Recover accidentally deleted items and lists
Dark/Light Themes - Beautiful UI that adapts to your preferences
Internationalization - Support for multiple languages via Crowdin
WearOS Support - View lists and complete items from your smartwatch
Smart Suggestions - AI-powered item suggestions using TensorFlow Lite
Home Widgets - Quick access to your lists from your home screen
Export & Share - Share lists via various platforms

Quick Start¶

Web AppAndroidBuild from Source

Visit app.shopsync.aadish.dev to start using ShopSync instantly in your browser.

Download from Google Play Store:

git clone https://github.com/ASDev-Official/ShopSync.git
cd ShopSync
flutter pub get
flutter run

Why ShopSync?¶

For Users¶

Simple & Intuitive - Clean interface that anyone can use
Always Available - Works offline and syncs when online
Free & Open Source - No hidden costs or vendor lock-in
Privacy Focused - Your data is yours, secured with Firebase

For Developers¶

Modern Flutter - Built with Flutter 3.6+ and Dart 3.0+
Clean Architecture - Well-organized codebase following best practices
Firebase Powered - Authentication, Firestore, and Cloud Functions
Extensive Documentation - Comprehensive guides and API references
Active Development - Regular updates and community contributions

Technology Stack¶

Flutter

Cross-platform UI framework

Firebase

Authentication, Firestore, Cloud Functions

Dart

Modern programming language

Material Design 3

Beautiful, adaptive UI

Platform Support¶

Platform	Status	Download
Android	✅ Stable	Google Play
Web	✅ Stable	Web App
WearOS	✅ Stable	Included with Android
iOS	🚧 Planned	Coming Soon
macOS	🚧 Planned	Coming Soon
Linux	🚧 Planned	Coming Soon
Windows	🚧 Planned	Coming Soon