A home for the things we share
OurArchive is a collaborative household inventory management app that helps families and friends track items through an intuitive, hierarchical organization system.
- 📦 Hierarchical Organization - Rooms → Shelves → Boxes (infinitely nestable)
- 👥 Household Sharing - Create households with unique 6-character invite codes
- 📸 Photo Management - Capture and store item photos with automatic compression
- 📚 ISBN Barcode Scanner - Automatically populate book details from barcodes
- 🔍 Smart Search - Find items quickly with filters by type, container, and tags
- 🔒 Role-Based Access - Owner, Member, Viewer, and Pending roles with approval system
- 📱 Offline-First - Works without internet, syncs when connection is restored
- 🔐 Secure - Firebase Authentication with email/password and anonymous sign-in
- Flutter/Dart - Cross-platform mobile framework
- Firebase - Authentication, Firestore database, Cloud Storage, Crashlytics
- Riverpod - State management
- Material Design 3 - Modern, clean UI
-
Clone and install dependencies:
git clone https://github.com/yourusername/OurArchive.git cd OurArchive/our_archive fvm flutter pub get -
Set up Firebase:
- See docs/FIREBASE_SETUP.md for detailed Firebase configuration
-
Run the app:
fvm flutter run
-
Run tests:
fvm flutter test
See QUICK_START.md for detailed development setup.
- Documentation Hub - Complete documentation index
- Firebase Setup - Firebase configuration and deployment
- Architecture - System design and widget library
- Features - Complete feature documentation
- Roadmap - Development plans and timeline
- Testing - Testing strategy and procedures
- Project Guidelines - Development guidelines and conventions
Current: Beta - Core features complete, ready for testing
[Add license information here]
Contributions are welcome! Please feel free to submit issues or pull requests.