opensource-ecommerce-mobile-app README

The project's README from github.com/bagisto/opensource-ecommerce-mobile-app. As one markdown file: README.md.

Total Downloads

Ask DeepWiki

Open Source eCommerce Mobile App

Bagisto revolutionizes the world of mobile commerce with its open-source eCommerce mobile app solution. This open-source mobile ecommerce 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 tech-savvy individuals and those new to eCommerce.

This mobile app, built on the foundation of the Bagisto eCommerce framework and leveraging the robust Laravel stack, offers many 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.

Live Demo

Android: https://play.google.com/store/apps/details?id=com.webkul.bagisto.mobikul

iOS: https://apps.apple.com/us/app/mobikul-bagisto-laravel-app/id6447519140

Features

The open-source ecommerce mobile app comes with an array of features to improve your customers' shopping experience.

Interactive Home Page and Search

All Type Product Supported

All Type Product Supported

Dark Mode and Push Notification

Dark Mode and Push Notification

Discount Coupons and Guest Checkout

Discount Coupons and Guest Checkout

Wishlist and Product Category

Wishlist and Product Category

Order Details and Product Reviews

Order Details and Product Reviews

Installation Guide

Before beginning with the installation, you will need the following with the mentioned versions

Make sure you have installed the API module and set this up properly on your bagisto.

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

git clone https://github.com/bagisto/opensource-ecommerce-mobile-app.git

Install dependencies

cd <repository-name>
flutter pub get

Connect a device or emulator

Run the Project

flutter run

Minimum Versions

Configurations Steps

For Setup

Change the baseDomain as per your store

Go to lib/core/constants/api_constants.dart and configure the following:

/// Bagisto GraphQL endpoint (e.g., https://your-bagisto-server.com/graphql)
const String bagistoEndpoint = 'YOUR_BAGISTO_ENDPOINT_HERE';

/// Storefront key for Bagisto API
/// Get this from your Bagisto admin panel
const String storefrontKey = 'YOUR_STOREFRONT_KEY_HERE';

/// Company name (optional metadata)
const String companyName = 'Your Company Name';

For Theme

In the AppColors class, find and modify the primary colors:

class AppColors {
  // Primary Colors - Modify these hex values to change the app's primary color
  static const Color primary500 = Color(0xFFFF6900);  // Main primary color
  static const Color primary600 = Color(0xFFF54900);  // Darker variant for pressed states
  // ...
}

To change the primary color:

For Push Notification Service

Replace "google-services.json".

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

For Splash Screen

For App Icon

Installation Video

Watch the video

API Documentation

For the API Documentation, please go through - https://api-docs.bagisto.com/api/graphql-api/introduction.html

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.

opensource-ecommerce-mobile-app (bagisto/opensource-ecommerce-mobile-app)

laravel
Searching Database…

What is this?This is the official mobile app for Bagisto, an open-source ecommerce platform, letting you turn a Bagisto store into a mobile shopping app with real-time synced products, categories, and orders.
Is this a standalone app or does it need a Bagisto store behind it?It's a Flutter mobile client that connects to an existing Bagisto store (built on Laravel) via an API; it has no standalone backend of its own.
How do I get it running?Clone the repo, run the Flutter dependency install command in the project directory, connect a physical device or start an emulator, then build and run the project with the Flutter run command.
Do I need anything set up before cloning this?You need a working Flutter environment and a running Bagisto store to point the app at; the README recommends testing a Flutter 'Hello World' first to confirm your setup works.
What are the minimum OS versions supported?The app requires Android 22 or higher and iOS 15.5 or higher.
How do I connect the app to my own store?Edit lib/core/constants/apiconstants.dart and change the baseDomain value to point to your own Bagisto store.
Can I customize the app's branding?Yes, you can change the primary theme color by editing the AppColors class, replacing the hex value and adjusting the darker primary600 shade, and you can swap app icons for Android and iOS.
Does it support push notifications?Yes, by replacing the google-services.json file for Android and the GoogleService-Info.plist file for iOS with your own Firebase configuration.
Why use this instead of building a mobile storefront from scratch?It gives Bagisto store owners a ready-made Flutter app with real-time product and order sync out of the box, cutting time-to-market instead of building a mobile client from zero.
Creator
bagisto
Size
9.8 MB
Stars
16.1K
Age
2y
Commits · 90 Days