Update README.md

README.md

@@ -1,50 +1,162 @@
-# bagisto_mobile_ecommerce
+# Open Source eCommerce Mobile App
 
-Flutter Application.
 
-An easy to use, free and opensource bagisto mobile ecommerce application.
+[Bagisto](https://bagisto.com/en/) revolutionizes the world of mobile commerce with its open-source eCommerce mobile app solution. This app seamlessly transforms your Bagisto store into a powerful mobile platform, providing real-time synchronization of products and categories. With a user-friendly interface, managing orders becomes a breeze, making it an essential tool for both tech-savvy individuals and those new to eCommerce.
 
-Bagisto can help you cut down your time, cost, and workforce for building online stores or migrating from physical stores to the ever-demanding online world.
-Your business -- whether small or huge -- get's benefit. And it's straightforward to set it up.
+This mobile app, built on the foundation of the Bagisto eCommerce framework and leveraging the robust Laravel stack, offers a plethora of features for a comprehensive and efficient mobile shopping experience. The app ensures easy product information management and accelerates time-to-market for your products, all while giving you complete control over your store.
 
-This app helps you to increase conversion rate and decrease abandoned cart rate. It also helps you to increase customer engagement.
+## Installation Guide
 
+Before beginning with the installation, you will need the following with the mentioned versions
 
+- Android Studio Version - Flamingo | 2022.2.1 
+- Flutter Version - 3.10.1
+- Dart - 3.0.1
+- Xcode - 14.3
+- Swift - 5
 
-<img src=Docs/Images/homepage.png width="350" height="700" align="left"/> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src=Docs/Images/navigationDrawer.png width="350" height="700"/>
+Make sure you have installed the API module and set this up properly on your bagisto.
 
-<img src=Docs/Images/cart.png width="350" height="700"/>
+> NOTE: It is recommended that you run a simple Hello World program in Flutter first before proceeding further so that you are sure that the environment is properly set up.
 
+## Installation Steps
 
+### Clone the repository
 
-# Minimum OS Version
-ios -> 9.0
-Android -> 21
+- Open your terminal or command prompt
+- Navigate to the directory where you want to save the project
+- Use the git clone command followed by the repository URL
 
-# Bagisto Compatible Version
-Bagisto 1.4.5
+```sh
+git clone https://github.com/<username>/<repository-name>.git
+```
+### Install dependencies
 
-# For Server Configuration
+- Navigate to the project's directory
 
-- Go to Project/Docs/ServerConfig.md
+```sh
+cd <repository-name>
+```
+
+- Run the following command to install the required packages
 
-# For setup color code in the app:
+```sh
+flutter pub get
+```
+### Connect a device or emulator
 
-- Go to Project/Docs/ColorSetUp.md
+* Physical Device
 
-# For Placeholder
+ 1. Enable USB debugging on your device
+ 2. Connect it to your computer using a USB cable.
 
-- Go to Project/Docs/PlaceholderSetup.md
+* Emulator
 
-# For installation Guide
+ 1. Start an Android or iOS emulator using your preferred IDE or tools.
+
+### Run the Project
 
-- Go to Project/Docs/InstallationGuide.md
+- Use the following command to build and run the project
 
-# For Configuration Guide
+```sh
+flutter run
+```
+## Minimum Versions
+
+- Android: 21
+- iOS: 12
+
+## Configurations Steps
+
+### For Setup
+
+Change the baseUrl as per your store
+
+**Path:** lib/utils/server_configuration.dart
+
+```sh
+static const String baseUrl = ‘....’;
+```
+> Note: Add the value of the complete URL ending with the GraphQL API endpoint. E.g - https://example.com/public/graphql 
+
+### For Theme
+
+Change the Theme for your app
+
+**Path:** lib/utils/mobikul_theme.dart
+
+```sh
+static const Color primaryColor = Color(***********); 
+static const Color accentColor = Color(***********); 
+```
+
+### For Push Notification Service
+
+- Android 
+
+Replace "google-services.json".
+- iOS 
+
+Replace "GoogleService-Info.plist".
+
+> Helpful Articles
+
+> Android → https://mobikul.com/knowledgebase/generating-google-service-file-enable-fcm-firebase-cloud-messaging-android-application/
+> iOS → https://mobikul.com/knowledgebase/generating-new-googleservice-info-plist-file-fcm-based-project-ios-app/
+
+### For Application Title
+
+* Android
+
+ 1. **Path:** android/app/src/main/AndroidManifest.xml
+ 2. **Change app name:** android:label="***********"
+
+* iOS
+
+ 1. Go to the general tab and identity change the display name to your app name
+
+> For Homepage Header Title - Go to ‘assets/language/en.json’
+> (Note: Here, “en” in en.json refers to the languages that would be supported within the application)
+
+### For Splash Screen
+
+* For adding Lottie as Splash Screen
+
+ 1. **Path:** assets/lottie/splash_screen.json
+ 2. After updating the Lottie file, update the ‘splashLottie’ in lib/utils/assets_constants.
+
+```sh
+ static const String splashLottie = "assets/lottie/splash_screen.json";
+```
+
+* For adding an Image as a Splash Screen
+
+ 1. **Path:** assets/images/splash.png
+ 2. After updating the Image file, update the ‘splashImage’ in lib/utils/assets_constants.
+
+```sh
+ static const String splashImage = "assets/images/splash.png";
+```
+### For App Icon
+
+* **Android:** open the Android folder right click app > new > Image Asset set Image.
+* **iOS:** ios/Runner/Assets.xcassets/AppIcon.appiconset
+
+## API Documentation
+
+For the API Documentation, please go through - https://github.com/bagisto/headless-ecommerce/
+
+## Usage
+
+For detailed usage instructions, refer to the official documentation
+
+## Contributing
+
+Contributions are welcome! Follow the contribution guidelines to get started.
+
+## License
+
+Bagisto is open-sourced software licensed under the MIT license.
 
-- Go to Project/Docs/ConfigGuide.md
 
-# Important Links
 
-- Flutter Related Information [ https://pub.dev/ ] 
-- Android Studio & Environment[ https://developer.android.com/ ]