|
1 | | -# template |
2 | | -A Template Repository for OpenSpringFest (OSF) |
| 1 | +# The Wallpaper Company |
| 2 | + |
| 3 | +A production-ready Flutter wallpaper app for the Kroozelabs Intern Challenge. |
| 4 | + |
| 5 | +## Screenshots |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## Setup & Installation |
| 12 | + |
| 13 | +1. **Clone the repository:** |
| 14 | + ```bash |
| 15 | + git clone <your-repo-url> |
| 16 | + cd the_wallpaper_company |
| 17 | + ``` |
| 18 | +2. **Install dependencies:** |
| 19 | + ```bash |
| 20 | + flutter pub get |
| 21 | + ``` |
| 22 | +3. **Run the app:** |
| 23 | + ```bash |
| 24 | + flutter run |
| 25 | + ``` |
| 26 | + |
| 27 | +## Firebase Setup |
| 28 | + |
| 29 | +1. Install the FlutterFire CLI: |
| 30 | + ```bash |
| 31 | + dart pub global activate flutterfire_cli |
| 32 | + ``` |
| 33 | +2. Login to Firebase: |
| 34 | + ```bash |
| 35 | + flutterfire login |
| 36 | + ``` |
| 37 | +3. Initialize Firebase in your project: |
| 38 | + ```bash |
| 39 | + flutterfire configure |
| 40 | + ``` |
| 41 | + - Select your Firebase project and platforms (Android/iOS). |
| 42 | + - This will generate `lib/firebase_options.dart` automatically. |
| 43 | +4. Add `google-services.json` (Android) to `android/app/`. |
| 44 | +5. Add `GoogleService-Info.plist` (iOS) to `ios/Runner/`. |
| 45 | +6. Enable **Cloud Messaging** and **Remote Config** in the Firebase Console. |
| 46 | + |
| 47 | +For more details, see the [FlutterFire CLI documentation](https://firebase.flutter.dev/docs/cli/). |
| 48 | + |
| 49 | +## Remote Config Keys Used |
| 50 | + |
| 51 | +- `dark_mode_enabled` (bool): Toggles dark mode in the app. |
| 52 | + - Example usage: `remoteConfig.getBool('dark_mode_enabled')` |
| 53 | + |
| 54 | +## JSON Endpoint Usage |
| 55 | + |
| 56 | +Wallpapers are fetched from: |
| 57 | +``` |
| 58 | +https://jsonkeeper.com/b/ORGZR |
| 59 | +``` |
| 60 | +- The endpoint returns a list of wallpaper objects in JSON format. |
| 61 | +- Each wallpaper object contains: `id`, `title`, `imageUrl`, `category`. |
| 62 | + |
| 63 | + |
| 64 | +## Features |
| 65 | +- Home screen with category carousel |
| 66 | +- Staggered grid and shimmer loading(Printerest Style) |
| 67 | +- Fullscreen preview and favorites |
| 68 | +- Pull-to-refresh and double-tap to like animation |
| 69 | +- Firebase Remote Config for dark mode |
| 70 | +- Firebase Cloud Messaging for notifications |
| 71 | +- Provider for state management |
| 72 | +- Persistent image cache |
| 73 | +- Modern UI |
| 74 | + |
| 75 | +## License |
| 76 | +MIT |
0 commit comments