Getting Started with ShopSync¶
Welcome to ShopSync! This guide will help you get up and running with ShopSync, whether you're using it as an end user or setting it up for development.
Choose Your Path¶
- End User
Just want to use ShopSync? Get started in minutes!
- Developer
Want to contribute or customize ShopSync?
What You'll Need¶
For End Users¶
- A Google account for authentication
- Internet connection (for initial setup and syncing)
- One of the following:
- Android device (Android 5.0+)
- Web browser (Chrome, Firefox, Safari, Edge)
- WearOS device (optional, for smartwatch access)
For Developers¶
- Flutter SDK (^3.6.0 or later)
- Dart SDK (^3.0.0 or later)
- Firebase Account (free tier works great)
- IDE: Android Studio, VS Code, or IntelliJ IDEA
- Git for version control
- Basic knowledge of Flutter and Firebase
Features Overview¶
Before diving in, here's what ShopSync offers:
Core Features¶
| Feature | Description | Availability |
|---|---|---|
| Real-time Sync | Changes appear instantly on all devices | All platforms |
| Offline Mode | Full functionality without internet | All platforms |
| Multi-user Lists | Share lists with family and friends | All platforms |
| Smart Suggestions | AI-powered item suggestions | Android, Web |
| Recycle Bin | Recover deleted items | All platforms |
| Categories | Organize items by category | All platforms |
| List Groups | Group related lists together | All platforms |
| Dark Theme | Beautiful dark and light themes | All platforms |
Platform-Specific Features¶
- Home Widgets for quick access
- WearOS companion app
- Google Sign-In with Credential Manager
- In-app updates
- Google Mobile Ads integration
- Progressive Web App (PWA) support
- Responsive design for all screen sizes
- Fast loading with optimized builds
- Rotary input support
- Optimized UI for small screens
- View lists and complete/uncomplete items
- Read-only companion app (create/edit on phone/web)
Next Steps¶
Ready to begin? Choose your next step:
- Quick Start - Get using ShopSync immediately
- Installation - Set up the development environment
- Firebase Setup - Configure Firebase for your project
Getting Help¶
Need assistance? Check out these resources:
- User Guide - Learn how to use all features
- FAQ - Common questions and answers
- Issue Tracker - Report bugs
- Discussions - Ask questions
Let's get started! 