Table of Contents

1. General Info
2. Screenshots
3. Showcase
4. Technologies
5. GIFs

General Info

---

Grocery Firestore Flutter Template

This is a template project which serves the purpose of firestore database management, state management, route management, localisation management & app theme management. Fetching, Adding, updating & deleting of the entries from firestore database is implemented in this template with the help of firebase dependencies and crud firestore data source and repository impl classes. State management, route management & app theme management is also implemented with the use of "GetX" library. State management is performed with the help of "GetX controllers" along with some core classes which handles lots of basic functionalities like search, filters, pagination etc. Route management is performed with the help of "Bindings". App theme management is performed with the use of controllers and "GetX" functions. Localisation with the support of two languages "EN" & "ES" is also implemented in this template with the help of flutter_intl & GetX controllers.

Following are some modules included in this project.

1. Dashboard
2. Grocery
3. Settings

Screenshots

---

Light Mode

Splash page	Grocery list page	Settings page	Add Grocery popUp

Dark Mode

Splash page	Grocery list page	Settings page	Add Grocery popUp

Spanish language (ES)

Grocery list page	Settings page	Add Grocery popUp

Showcase

---

This project is build to Showcase following things implemented in this project.

1. Firestore database management.
2. Clean Architecture
3. State management using GetX.
4. Route management using GetX.
5. Advance code structure.
6. Firestore datastore CRUD impl.
7. Localisation.
8. App Theme management using GetX.

Folder Structure

.
├── _config                             # files for enviornment related settings DEV, PROD 
├── _core                               # core file independent of project/app  
├── _shared                             # project dependent but app independent   
├── app                                 # app-specific files modules based on clean architecture. 
│   ├── di                              # a centralized place to manage all dependencies in app
│   ├── extra                           # common files like enums, images, fields files
│   ├── modules                         # various functional modules/features of app
│   │   ├── grocery                     # gorcery specific files 
│   │   │   ├── data                    # responsible for data fetching from remote or local database  
│   │   │   │   ├── sources             # various data sources like local, remote to communicate with respetive source.
│   │   │   │   └── repositories        # Reponsible for managing data sources. It has actual implementation.
│   │   │   ├── domain                  # This is the central layer of the feature with all business logic.
│   │   │   │   ├── entities            # The model class which is mapped from data model class.
│   │   │   │   ├── repositories        # Rules of what needs to be implemented to obtain domain model.
│   │   │   │   └── usecases            # A unique use case for every logic inside a particular feature.
│   │   │   └── presentation            # UI layer for data showing and user interactions.
│   │   │       ├── controllers         # Unit tests
│   │   │       ├── pages               # representing a single screen of the feature
│   │   │       └── widgets             # Resuable widgets
│   │   └── dashboad                      
│   ├── ui                              # app theme, style guides, resusable ui components
│   ├── utils                           # app specific utils
│   └── widgets                         # common resusable ui components
├── generated                           # automatic generated language files
├── l10n                                # supported language files
└── main.dart                           # Entry point

Running this project

1. Clone project in local repository.
2. Run command flutter pub get
3. Run command flutter pub global run intl_utils:generate.

Technologies

---

Following technologies are used in this project.

core packages

1. [dartz] (https://pub.dev/packages/dartz)
2. [equatable] (https://pub.dev/packages/equatable)

shared dependency

1. [get_storage] (https://pub.dev/packages/get_storage)
2. [logger] (https://pub.dev/packages/logger)

app dependency

1. [intl] (https://pub.dev/packages/intl)
2. [intl_utils] (https://pub.dev/packages/intl_utils)
3. [get] (flutter sdk)
4. [get_it] (flutter sdk)
5. [flutter_localizations] (flutter sdk)
6. [cupertino_icons] (https://pub.dev/packages/cupertino_icons)
7. [persistent_bottom_nav_bar] (https://pub.dev/packages/persistent_bottom_nav_barr)
8. [fluttertoast] (https://pub.dev/packages/fluttertoast)
9. [sized_context] (https://pub.dev/packages/sized_context) 10.[time] (https://pub.dev/packages/time) 11.[timeago] (https://pub.dev/packages/timeago) 12.[connectivity] (https://pub.dev/packages/connectivity)

firebase dependency

1. [firebase_core] (https://pub.dev/packages/firebase_core)
2. [firebase_storage] (https://pub.dev/packages/firebase_storage)
3. [firebase_auth] (https://pub.dev/packages/firebase_auth)
4. [cloud_firestore] (https://pub.dev/packages/cloud_firestore)
5. [cloud_functions] (https://pub.dev/packages/cloud_functions)

GIFs

---

Sample for adding data to firestore DB.

Sample for changing app theme mode.

Sample for deleting data from firestore DB.

Sample for changing app language.

Sample for search implemented in app.